From a2c3e08e14c73262d511454c1044d43949fcac30 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:25:09 +0000 Subject: [PATCH 1/2] docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: https://github.com/googleapis/googleapis/commit/8a085aeddfa010af5bcef090827aac5255383d7e Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 --- owl-bot-staging/v1/.coveragerc | 13 + owl-bot-staging/v1/.flake8 | 33 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 + .../v1/docs/domains_v1/domains.rst | 10 + .../v1/docs/domains_v1/services.rst | 6 + owl-bot-staging/v1/docs/domains_v1/types.rst | 6 + owl-bot-staging/v1/docs/index.rst | 7 + .../v1/google/cloud/domains/__init__.py | 89 + .../v1/google/cloud/domains/gapic_version.py | 16 + .../v1/google/cloud/domains/py.typed | 2 + .../v1/google/cloud/domains_v1/__init__.py | 90 + .../cloud/domains_v1/gapic_metadata.json | 253 + .../google/cloud/domains_v1/gapic_version.py | 16 + .../v1/google/cloud/domains_v1/py.typed | 2 + .../cloud/domains_v1/services/__init__.py | 15 + .../domains_v1/services/domains/__init__.py | 22 + .../services/domains/async_client.py | 2284 +++++ .../domains_v1/services/domains/client.py | 2488 +++++ .../domains_v1/services/domains/pagers.py | 139 + .../services/domains/transports/__init__.py | 38 + .../services/domains/transports/base.py | 351 + .../services/domains/transports/grpc.py | 742 ++ .../domains/transports/grpc_asyncio.py | 741 ++ .../services/domains/transports/rest.py | 1976 ++++ .../google/cloud/domains_v1/types/__init__.py | 82 + .../google/cloud/domains_v1/types/domains.py | 1523 +++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 184 + ...omains_configure_contact_settings_async.py | 56 + ...domains_configure_contact_settings_sync.py | 56 + ...ed_domains_configure_dns_settings_async.py | 56 + ...ted_domains_configure_dns_settings_sync.py | 56 + ...ins_configure_management_settings_async.py | 56 + ...ains_configure_management_settings_sync.py | 56 + ...rated_domains_delete_registration_async.py | 56 + ...erated_domains_delete_registration_sync.py | 56 + ...rated_domains_export_registration_async.py | 56 + ...erated_domains_export_registration_sync.py | 56 + ...enerated_domains_get_registration_async.py | 52 + ...generated_domains_get_registration_sync.py | 52 + ...erated_domains_list_registrations_async.py | 53 + ...nerated_domains_list_registrations_sync.py | 53 + ...generated_domains_register_domain_async.py | 67 + ..._generated_domains_register_domain_sync.py | 67 + ..._domains_reset_authorization_code_async.py | 52 + ...d_domains_reset_authorization_code_sync.py | 52 + ...mains_retrieve_authorization_code_async.py | 52 + ...omains_retrieve_authorization_code_sync.py | 52 + ...ains_retrieve_register_parameters_async.py | 53 + ...mains_retrieve_register_parameters_sync.py | 53 + ...ains_retrieve_transfer_parameters_async.py | 53 + ...mains_retrieve_transfer_parameters_sync.py | 53 + ..._generated_domains_search_domains_async.py | 53 + ...1_generated_domains_search_domains_sync.py | 53 + ...generated_domains_transfer_domain_async.py | 67 + ..._generated_domains_transfer_domain_sync.py | 67 + ...rated_domains_update_registration_async.py | 55 + ...erated_domains_update_registration_sync.py | 55 + ...ppet_metadata_google.cloud.domains.v1.json | 2550 +++++ .../v1/scripts/fixup_domains_v1_keywords.py | 190 + owl-bot-staging/v1/setup.py | 90 + .../v1/testing/constraints-3.10.txt | 6 + .../v1/testing/constraints-3.11.txt | 6 + .../v1/testing/constraints-3.12.txt | 6 + .../v1/testing/constraints-3.7.txt | 9 + .../v1/testing/constraints-3.8.txt | 6 + .../v1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../tests/unit/gapic/domains_v1/__init__.py | 16 + .../unit/gapic/domains_v1/test_domains.py | 8728 +++++++++++++++++ owl-bot-staging/v1beta1/.coveragerc | 13 + owl-bot-staging/v1beta1/.flake8 | 33 + owl-bot-staging/v1beta1/MANIFEST.in | 2 + owl-bot-staging/v1beta1/README.rst | 49 + owl-bot-staging/v1beta1/docs/conf.py | 376 + .../v1beta1/docs/domains_v1beta1/domains.rst | 10 + .../v1beta1/docs/domains_v1beta1/services.rst | 6 + .../v1beta1/docs/domains_v1beta1/types.rst | 6 + owl-bot-staging/v1beta1/docs/index.rst | 7 + .../v1beta1/google/cloud/domains/__init__.py | 89 + .../google/cloud/domains/gapic_version.py | 16 + .../v1beta1/google/cloud/domains/py.typed | 2 + .../google/cloud/domains_v1beta1/__init__.py | 90 + .../cloud/domains_v1beta1/gapic_metadata.json | 253 + .../cloud/domains_v1beta1/gapic_version.py | 16 + .../google/cloud/domains_v1beta1/py.typed | 2 + .../domains_v1beta1/services/__init__.py | 15 + .../services/domains/__init__.py | 22 + .../services/domains/async_client.py | 2284 +++++ .../services/domains/client.py | 2488 +++++ .../services/domains/pagers.py | 139 + .../services/domains/transports/__init__.py | 38 + .../services/domains/transports/base.py | 351 + .../services/domains/transports/grpc.py | 742 ++ .../domains/transports/grpc_asyncio.py | 741 ++ .../services/domains/transports/rest.py | 1976 ++++ .../cloud/domains_v1beta1/types/__init__.py | 82 + .../cloud/domains_v1beta1/types/domains.py | 1523 +++ owl-bot-staging/v1beta1/mypy.ini | 3 + owl-bot-staging/v1beta1/noxfile.py | 184 + ...omains_configure_contact_settings_async.py | 56 + ...domains_configure_contact_settings_sync.py | 56 + ...ed_domains_configure_dns_settings_async.py | 56 + ...ted_domains_configure_dns_settings_sync.py | 56 + ...ins_configure_management_settings_async.py | 56 + ...ains_configure_management_settings_sync.py | 56 + ...rated_domains_delete_registration_async.py | 56 + ...erated_domains_delete_registration_sync.py | 56 + ...rated_domains_export_registration_async.py | 56 + ...erated_domains_export_registration_sync.py | 56 + ...enerated_domains_get_registration_async.py | 52 + ...generated_domains_get_registration_sync.py | 52 + ...erated_domains_list_registrations_async.py | 53 + ...nerated_domains_list_registrations_sync.py | 53 + ...generated_domains_register_domain_async.py | 67 + ..._generated_domains_register_domain_sync.py | 67 + ..._domains_reset_authorization_code_async.py | 52 + ...d_domains_reset_authorization_code_sync.py | 52 + ...mains_retrieve_authorization_code_async.py | 52 + ...omains_retrieve_authorization_code_sync.py | 52 + ...ains_retrieve_register_parameters_async.py | 53 + ...mains_retrieve_register_parameters_sync.py | 53 + ...ains_retrieve_transfer_parameters_async.py | 53 + ...mains_retrieve_transfer_parameters_sync.py | 53 + ..._generated_domains_search_domains_async.py | 53 + ...1_generated_domains_search_domains_sync.py | 53 + ...generated_domains_transfer_domain_async.py | 67 + ..._generated_domains_transfer_domain_sync.py | 67 + ...rated_domains_update_registration_async.py | 55 + ...erated_domains_update_registration_sync.py | 55 + ...metadata_google.cloud.domains.v1beta1.json | 2550 +++++ .../scripts/fixup_domains_v1beta1_keywords.py | 190 + owl-bot-staging/v1beta1/setup.py | 90 + .../v1beta1/testing/constraints-3.10.txt | 6 + .../v1beta1/testing/constraints-3.11.txt | 6 + .../v1beta1/testing/constraints-3.12.txt | 6 + .../v1beta1/testing/constraints-3.7.txt | 9 + .../v1beta1/testing/constraints-3.8.txt | 6 + .../v1beta1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v1beta1/tests/__init__.py | 16 + .../v1beta1/tests/unit/__init__.py | 16 + .../v1beta1/tests/unit/gapic/__init__.py | 16 + .../unit/gapic/domains_v1beta1/__init__.py | 16 + .../gapic/domains_v1beta1/test_domains.py | 8728 +++++++++++++++++ 148 files changed, 49786 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/.flake8 create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/domains_v1/domains.rst create mode 100644 owl-bot-staging/v1/docs/domains_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/domains_v1/types.rst create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/google/cloud/domains/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/domains/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json create mode 100644 owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py create mode 100644 owl-bot-staging/v1beta1/.coveragerc create mode 100644 owl-bot-staging/v1beta1/.flake8 create mode 100644 owl-bot-staging/v1beta1/MANIFEST.in create mode 100644 owl-bot-staging/v1beta1/README.rst create mode 100644 owl-bot-staging/v1beta1/docs/conf.py create mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst create mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst create mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst create mode 100644 owl-bot-staging/v1beta1/docs/index.rst create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py create mode 100644 owl-bot-staging/v1beta1/mypy.ini create mode 100644 owl-bot-staging/v1beta1/noxfile.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json create mode 100644 owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py create mode 100644 owl-bot-staging/v1beta1/setup.py create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v1beta1/tests/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..4cecf7e --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/domains/__init__.py + google/cloud/domains/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..44b9d49 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/domains *.py +recursive-include google/cloud/domains_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..6f21f3f --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Domains 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 Domains API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..2345777 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-domains documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-domains" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-domains-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-domains.tex", + u"google-cloud-domains 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-domains", + u"Google Cloud Domains 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-domains", + u"google-cloud-domains Documentation", + author, + "google-cloud-domains", + "GAPIC library for Google Cloud Domains API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/domains_v1/domains.rst b/owl-bot-staging/v1/docs/domains_v1/domains.rst new file mode 100644 index 0000000..bfb140d --- /dev/null +++ b/owl-bot-staging/v1/docs/domains_v1/domains.rst @@ -0,0 +1,10 @@ +Domains +------------------------- + +.. automodule:: google.cloud.domains_v1.services.domains + :members: + :inherited-members: + +.. automodule:: google.cloud.domains_v1.services.domains.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/domains_v1/services.rst b/owl-bot-staging/v1/docs/domains_v1/services.rst new file mode 100644 index 0000000..1073e86 --- /dev/null +++ b/owl-bot-staging/v1/docs/domains_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Domains v1 API +======================================== +.. toctree:: + :maxdepth: 2 + + domains diff --git a/owl-bot-staging/v1/docs/domains_v1/types.rst b/owl-bot-staging/v1/docs/domains_v1/types.rst new file mode 100644 index 0000000..f2fefd0 --- /dev/null +++ b/owl-bot-staging/v1/docs/domains_v1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Domains v1 API +===================================== + +.. automodule:: google.cloud.domains_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..e880d37 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + domains_v1/services + domains_v1/types diff --git a/owl-bot-staging/v1/google/cloud/domains/__init__.py b/owl-bot-staging/v1/google/cloud/domains/__init__.py new file mode 100644 index 0000000..d40dce0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains/__init__.py @@ -0,0 +1,89 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.domains import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.domains_v1.services.domains.client import DomainsClient +from google.cloud.domains_v1.services.domains.async_client import DomainsAsyncClient + +from google.cloud.domains_v1.types.domains import AuthorizationCode +from google.cloud.domains_v1.types.domains import ConfigureContactSettingsRequest +from google.cloud.domains_v1.types.domains import ConfigureDnsSettingsRequest +from google.cloud.domains_v1.types.domains import ConfigureManagementSettingsRequest +from google.cloud.domains_v1.types.domains import ContactSettings +from google.cloud.domains_v1.types.domains import DeleteRegistrationRequest +from google.cloud.domains_v1.types.domains import DnsSettings +from google.cloud.domains_v1.types.domains import ExportRegistrationRequest +from google.cloud.domains_v1.types.domains import GetRegistrationRequest +from google.cloud.domains_v1.types.domains import ListRegistrationsRequest +from google.cloud.domains_v1.types.domains import ListRegistrationsResponse +from google.cloud.domains_v1.types.domains import ManagementSettings +from google.cloud.domains_v1.types.domains import OperationMetadata +from google.cloud.domains_v1.types.domains import RegisterDomainRequest +from google.cloud.domains_v1.types.domains import RegisterParameters +from google.cloud.domains_v1.types.domains import Registration +from google.cloud.domains_v1.types.domains import ResetAuthorizationCodeRequest +from google.cloud.domains_v1.types.domains import RetrieveAuthorizationCodeRequest +from google.cloud.domains_v1.types.domains import RetrieveRegisterParametersRequest +from google.cloud.domains_v1.types.domains import RetrieveRegisterParametersResponse +from google.cloud.domains_v1.types.domains import RetrieveTransferParametersRequest +from google.cloud.domains_v1.types.domains import RetrieveTransferParametersResponse +from google.cloud.domains_v1.types.domains import SearchDomainsRequest +from google.cloud.domains_v1.types.domains import SearchDomainsResponse +from google.cloud.domains_v1.types.domains import TransferDomainRequest +from google.cloud.domains_v1.types.domains import TransferParameters +from google.cloud.domains_v1.types.domains import UpdateRegistrationRequest +from google.cloud.domains_v1.types.domains import ContactNotice +from google.cloud.domains_v1.types.domains import ContactPrivacy +from google.cloud.domains_v1.types.domains import DomainNotice +from google.cloud.domains_v1.types.domains import TransferLockState + +__all__ = ('DomainsClient', + 'DomainsAsyncClient', + 'AuthorizationCode', + 'ConfigureContactSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureManagementSettingsRequest', + 'ContactSettings', + 'DeleteRegistrationRequest', + 'DnsSettings', + 'ExportRegistrationRequest', + 'GetRegistrationRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'ManagementSettings', + 'OperationMetadata', + 'RegisterDomainRequest', + 'RegisterParameters', + 'Registration', + 'ResetAuthorizationCodeRequest', + 'RetrieveAuthorizationCodeRequest', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'TransferDomainRequest', + 'TransferParameters', + 'UpdateRegistrationRequest', + 'ContactNotice', + 'ContactPrivacy', + 'DomainNotice', + 'TransferLockState', +) diff --git a/owl-bot-staging/v1/google/cloud/domains/gapic_version.py b/owl-bot-staging/v1/google/cloud/domains/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/domains/py.typed b/owl-bot-staging/v1/google/cloud/domains/py.typed new file mode 100644 index 0000000..b463d6c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py new file mode 100644 index 0000000..60fe31b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.domains_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.domains import DomainsClient +from .services.domains import DomainsAsyncClient + +from .types.domains import AuthorizationCode +from .types.domains import ConfigureContactSettingsRequest +from .types.domains import ConfigureDnsSettingsRequest +from .types.domains import ConfigureManagementSettingsRequest +from .types.domains import ContactSettings +from .types.domains import DeleteRegistrationRequest +from .types.domains import DnsSettings +from .types.domains import ExportRegistrationRequest +from .types.domains import GetRegistrationRequest +from .types.domains import ListRegistrationsRequest +from .types.domains import ListRegistrationsResponse +from .types.domains import ManagementSettings +from .types.domains import OperationMetadata +from .types.domains import RegisterDomainRequest +from .types.domains import RegisterParameters +from .types.domains import Registration +from .types.domains import ResetAuthorizationCodeRequest +from .types.domains import RetrieveAuthorizationCodeRequest +from .types.domains import RetrieveRegisterParametersRequest +from .types.domains import RetrieveRegisterParametersResponse +from .types.domains import RetrieveTransferParametersRequest +from .types.domains import RetrieveTransferParametersResponse +from .types.domains import SearchDomainsRequest +from .types.domains import SearchDomainsResponse +from .types.domains import TransferDomainRequest +from .types.domains import TransferParameters +from .types.domains import UpdateRegistrationRequest +from .types.domains import ContactNotice +from .types.domains import ContactPrivacy +from .types.domains import DomainNotice +from .types.domains import TransferLockState + +__all__ = ( + 'DomainsAsyncClient', +'AuthorizationCode', +'ConfigureContactSettingsRequest', +'ConfigureDnsSettingsRequest', +'ConfigureManagementSettingsRequest', +'ContactNotice', +'ContactPrivacy', +'ContactSettings', +'DeleteRegistrationRequest', +'DnsSettings', +'DomainNotice', +'DomainsClient', +'ExportRegistrationRequest', +'GetRegistrationRequest', +'ListRegistrationsRequest', +'ListRegistrationsResponse', +'ManagementSettings', +'OperationMetadata', +'RegisterDomainRequest', +'RegisterParameters', +'Registration', +'ResetAuthorizationCodeRequest', +'RetrieveAuthorizationCodeRequest', +'RetrieveRegisterParametersRequest', +'RetrieveRegisterParametersResponse', +'RetrieveTransferParametersRequest', +'RetrieveTransferParametersResponse', +'SearchDomainsRequest', +'SearchDomainsResponse', +'TransferDomainRequest', +'TransferLockState', +'TransferParameters', +'UpdateRegistrationRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json new file mode 100644 index 0000000..a2b2080 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json @@ -0,0 +1,253 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.domains_v1", + "protoPackage": "google.cloud.domains.v1", + "schema": "1.0", + "services": { + "Domains": { + "clients": { + "grpc": { + "libraryClient": "DomainsClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + }, + "grpc-async": { + "libraryClient": "DomainsAsyncClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + }, + "rest": { + "libraryClient": "DomainsClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/py.typed b/owl-bot-staging/v1/google/cloud/domains_v1/py.typed new file mode 100644 index 0000000..b463d6c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py new file mode 100644 index 0000000..28d2584 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import DomainsClient +from .async_client import DomainsAsyncClient + +__all__ = ( + 'DomainsClient', + 'DomainsAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py new file mode 100644 index 0000000..0ba840c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py @@ -0,0 +1,2284 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.domains_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.domains_v1.services.domains import pagers +from google.cloud.domains_v1.types import domains +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport +from .client import DomainsClient + + +class DomainsAsyncClient: + """The Cloud Domains API enables management and configuration of + domain names. + """ + + _client: DomainsClient + + DEFAULT_ENDPOINT = DomainsClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = DomainsClient.DEFAULT_MTLS_ENDPOINT + + registration_path = staticmethod(DomainsClient.registration_path) + parse_registration_path = staticmethod(DomainsClient.parse_registration_path) + common_billing_account_path = staticmethod(DomainsClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(DomainsClient.parse_common_billing_account_path) + common_folder_path = staticmethod(DomainsClient.common_folder_path) + parse_common_folder_path = staticmethod(DomainsClient.parse_common_folder_path) + common_organization_path = staticmethod(DomainsClient.common_organization_path) + parse_common_organization_path = staticmethod(DomainsClient.parse_common_organization_path) + common_project_path = staticmethod(DomainsClient.common_project_path) + parse_common_project_path = staticmethod(DomainsClient.parse_common_project_path) + common_location_path = staticmethod(DomainsClient.common_location_path) + parse_common_location_path = staticmethod(DomainsClient.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: + DomainsAsyncClient: The constructed client. + """ + return DomainsClient.from_service_account_info.__func__(DomainsAsyncClient, 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: + DomainsAsyncClient: The constructed client. + """ + return DomainsClient.from_service_account_file.__func__(DomainsAsyncClient, 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 DomainsClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> DomainsTransport: + """Returns the transport used by the client instance. + + Returns: + DomainsTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(DomainsClient).get_transport_class, type(DomainsClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, DomainsTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the domains client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.DomainsTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = DomainsClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def search_domains(self, + request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, + *, + location: 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, str]] = (), + ) -> domains.SearchDomainsResponse: + r"""Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + .. 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 domains_v1 + + async def sample_search_domains(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = await client.search_domains(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]]): + The request object. Request for the ``SearchDomains`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Required. String used to search for + available domain names. + + 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, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.SearchDomainsResponse: + Response for the SearchDomains method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, query]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.SearchDomainsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_domains, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def retrieve_register_parameters(self, + request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + .. 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 domains_v1 + + async def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]]): + The request object. Request for the ``RetrieveRegisterParameters`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (:class:`str`): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.RetrieveRegisterParametersResponse: + Response for the RetrieveRegisterParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveRegisterParametersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_register_parameters, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def register_domain(self, + request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + .. 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 domains_v1 + + async def sample_register_domain(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]]): + The request object. Request for the ``RegisterDomain`` method. + parent (:class:`str`): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (:class:`google.cloud.domains_v1.types.Registration`): + Required. The complete ``Registration`` resource to be + created. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (:class:`google.type.money_pb2.Money`): + Required. Yearly price to register or + renew the domain. The value that should + be put here can be obtained from + RetrieveRegisterParameters or + SearchDomains calls. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RegisterDomainRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.register_domain, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def retrieve_transfer_parameters(self, + request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveTransferParametersResponse: + r"""Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + .. 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 domains_v1 + + async def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]]): + The request object. Request for the ``RetrieveTransferParameters`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (:class:`str`): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.RetrieveTransferParametersResponse: + Response for the RetrieveTransferParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveTransferParametersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_transfer_parameters, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def transfer_domain(self, + request: Optional[Union[domains.TransferDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + authorization_code: Optional[domains.AuthorizationCode] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + .. 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 domains_v1 + + async def sample_transfer_domain(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]]): + The request object. Request for the ``TransferDomain`` method. + parent (:class:`str`): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (:class:`google.cloud.domains_v1.types.Registration`): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to + import the domain's current DNS configuration from its + current registrar. Use this option only if you are sure + that the domain's current DNS service does not cease + upon transfer, as is often the case for DNS services + provided for free by the registrar. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (:class:`google.type.money_pb2.Money`): + Required. Acknowledgement of the price to transfer or + renew the domain for one year. Call + ``RetrieveTransferParameters`` to obtain the price, + which you must acknowledge. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + authorization_code (:class:`google.cloud.domains_v1.types.AuthorizationCode`): + The domain's transfer authorization + code. You can obtain this from the + domain's current registrar. + + This corresponds to the ``authorization_code`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price, authorization_code]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.TransferDomainRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + if authorization_code is not None: + request.authorization_code = authorization_code + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.transfer_domain, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_registrations(self, + request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRegistrationsAsyncPager: + r"""Lists the ``Registration`` resources in a 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 domains_v1 + + async def sample_list_registrations(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]]): + The request object. Request for the ``ListRegistrations`` method. + parent (:class:`str`): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager: + Response for the ListRegistrations method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ListRegistrationsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_registrations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRegistrationsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_registration(self, + request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.Registration: + r"""Gets the details of a ``Registration`` 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 domains_v1 + + async def sample_get_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_registration(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]]): + The request object. Request for the ``GetRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to get, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.Registration: + The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.GetRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_registration(self, + request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, + *, + registration: Optional[domains.Registration] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + .. 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 domains_v1 + + async def sample_update_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]]): + The request object. Request for the ``UpdateRegistration`` method. + registration (:class:`google.cloud.domains_v1.types.Registration`): + Fields of the ``Registration`` to update. + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the labels are being updated, the ``update_mask`` is + ``"labels"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.UpdateRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration.name", request.registration.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_management_settings(self, + request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + management_settings: Optional[domains.ManagementSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s management settings. + + .. 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 domains_v1 + + async def sample_configure_management_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]]): + The request object. Request for the ``ConfigureManagementSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + management settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + management_settings (:class:`google.cloud.domains_v1.types.ManagementSettings`): + Fields of the ``ManagementSettings`` to update. + This corresponds to the ``management_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the transfer lock is being updated, the ``update_mask`` + is ``"transfer_lock_state"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, management_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureManagementSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if management_settings is not None: + request.management_settings = management_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_management_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_dns_settings(self, + request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + dns_settings: Optional[domains.DnsSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s DNS settings. + + .. 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 domains_v1 + + async def sample_configure_dns_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]]): + The request object. Request for the ``ConfigureDnsSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + dns_settings (:class:`google.cloud.domains_v1.types.DnsSettings`): + Fields of the ``DnsSettings`` to update. + This corresponds to the ``dns_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the name servers are being updated for an existing + Custom DNS configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains + DNS configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, dns_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureDnsSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if dns_settings is not None: + request.dns_settings = dns_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_dns_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_contact_settings(self, + request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + contact_settings: Optional[domains.ContactSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + .. 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 domains_v1 + + async def sample_configure_contact_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]]): + The request object. Request for the ``ConfigureContactSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact_settings (:class:`google.cloud.domains_v1.types.ContactSettings`): + Fields of the ``ContactSettings`` to update. + This corresponds to the ``contact_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the registrant contact is being updated, the + ``update_mask`` is ``"registrant_contact"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, contact_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureContactSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if contact_settings is not None: + request.contact_settings = contact_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_contact_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def export_registration(self, + request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1 + + async def sample_export_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]]): + The request object. Request for the ``ExportRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to export, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ExportRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.export_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_registration(self, + request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1 + + async def sample_delete_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]]): + The request object. Request for the ``DeleteRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to delete, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.DeleteRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def retrieve_authorization_code(self, + request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1 + + async def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]]): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveAuthorizationCodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_authorization_code, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def reset_authorization_code(self, + request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1 + + async def sample_reset_authorization_code(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.reset_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]]): + The request object. Request for the ``ResetAuthorizationCode`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ResetAuthorizationCodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.reset_authorization_code, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "DomainsAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py new file mode 100644 index 0000000..f529eee --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py @@ -0,0 +1,2488 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.domains_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.domains_v1.services.domains import pagers +from google.cloud.domains_v1.types import domains +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import DomainsGrpcTransport +from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport +from .transports.rest import DomainsRestTransport + + +class DomainsClientMeta(type): + """Metaclass for the Domains 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[DomainsTransport]] + _transport_registry["grpc"] = DomainsGrpcTransport + _transport_registry["grpc_asyncio"] = DomainsGrpcAsyncIOTransport + _transport_registry["rest"] = DomainsRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[DomainsTransport]: + """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 DomainsClient(metaclass=DomainsClientMeta): + """The Cloud Domains API enables management and configuration of + domain names. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "domains.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + DomainsClient: 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: + DomainsClient: 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) -> DomainsTransport: + """Returns the transport used by the client instance. + + Returns: + DomainsTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def registration_path(project: str,location: str,registration: str,) -> str: + """Returns a fully-qualified registration string.""" + return "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) + + @staticmethod + def parse_registration_path(path: str) -> Dict[str,str]: + """Parses a registration path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/registrations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, DomainsTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the domains client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, DomainsTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, DomainsTransport): + # transport is a DomainsTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def search_domains(self, + request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, + *, + location: 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, str]] = (), + ) -> domains.SearchDomainsResponse: + r"""Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + .. 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 domains_v1 + + def sample_search_domains(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = client.search_domains(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]): + The request object. Request for the ``SearchDomains`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Required. String used to search for + available domain names. + + 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, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.SearchDomainsResponse: + Response for the SearchDomains method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, query]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.SearchDomainsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.SearchDomainsRequest): + request = domains.SearchDomainsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + 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_domains] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def retrieve_register_parameters(self, + request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + .. 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 domains_v1 + + def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]): + The request object. Request for the ``RetrieveRegisterParameters`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (str): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.RetrieveRegisterParametersResponse: + Response for the RetrieveRegisterParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveRegisterParametersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveRegisterParametersRequest): + request = domains.RetrieveRegisterParametersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_register_parameters] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def register_domain(self, + request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + .. 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 domains_v1 + + def sample_register_domain(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]): + The request object. Request for the ``RegisterDomain`` method. + parent (str): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (google.cloud.domains_v1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (google.type.money_pb2.Money): + Required. Yearly price to register or + renew the domain. The value that should + be put here can be obtained from + RetrieveRegisterParameters or + SearchDomains calls. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RegisterDomainRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RegisterDomainRequest): + request = domains.RegisterDomainRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.register_domain] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def retrieve_transfer_parameters(self, + request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveTransferParametersResponse: + r"""Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + .. 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 domains_v1 + + def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]): + The request object. Request for the ``RetrieveTransferParameters`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (str): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.RetrieveTransferParametersResponse: + Response for the RetrieveTransferParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveTransferParametersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveTransferParametersRequest): + request = domains.RetrieveTransferParametersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_transfer_parameters] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def transfer_domain(self, + request: Optional[Union[domains.TransferDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + authorization_code: Optional[domains.AuthorizationCode] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + .. 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 domains_v1 + + def sample_transfer_domain(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]): + The request object. Request for the ``TransferDomain`` method. + parent (str): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (google.cloud.domains_v1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to + import the domain's current DNS configuration from its + current registrar. Use this option only if you are sure + that the domain's current DNS service does not cease + upon transfer, as is often the case for DNS services + provided for free by the registrar. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (google.type.money_pb2.Money): + Required. Acknowledgement of the price to transfer or + renew the domain for one year. Call + ``RetrieveTransferParameters`` to obtain the price, + which you must acknowledge. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + authorization_code (google.cloud.domains_v1.types.AuthorizationCode): + The domain's transfer authorization + code. You can obtain this from the + domain's current registrar. + + This corresponds to the ``authorization_code`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price, authorization_code]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.TransferDomainRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.TransferDomainRequest): + request = domains.TransferDomainRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + if authorization_code is not None: + request.authorization_code = authorization_code + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.transfer_domain] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_registrations(self, + request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRegistrationsPager: + r"""Lists the ``Registration`` resources in a 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 domains_v1 + + def sample_list_registrations(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]): + The request object. Request for the ``ListRegistrations`` method. + parent (str): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager: + Response for the ListRegistrations method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ListRegistrationsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ListRegistrationsRequest): + request = domains.ListRegistrationsRequest(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_registrations] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRegistrationsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_registration(self, + request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.Registration: + r"""Gets the details of a ``Registration`` 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 domains_v1 + + def sample_get_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = client.get_registration(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]): + The request object. Request for the ``GetRegistration`` method. + name (str): + Required. The name of the ``Registration`` to get, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.Registration: + The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.GetRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.GetRegistrationRequest): + request = domains.GetRegistrationRequest(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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_registration(self, + request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, + *, + registration: Optional[domains.Registration] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + .. 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 domains_v1 + + def sample_update_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]): + The request object. Request for the ``UpdateRegistration`` method. + registration (google.cloud.domains_v1.types.Registration): + Fields of the ``Registration`` to update. + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the labels are being updated, the ``update_mask`` is + ``"labels"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.UpdateRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.UpdateRegistrationRequest): + request = domains.UpdateRegistrationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + 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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration.name", request.registration.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_management_settings(self, + request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + management_settings: Optional[domains.ManagementSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s management settings. + + .. 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 domains_v1 + + def sample_configure_management_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]): + The request object. Request for the ``ConfigureManagementSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose + management settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + management_settings (google.cloud.domains_v1.types.ManagementSettings): + Fields of the ``ManagementSettings`` to update. + This corresponds to the ``management_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the transfer lock is being updated, the ``update_mask`` + is ``"transfer_lock_state"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, management_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureManagementSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureManagementSettingsRequest): + request = domains.ConfigureManagementSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if management_settings is not None: + request.management_settings = management_settings + 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.configure_management_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_dns_settings(self, + request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + dns_settings: Optional[domains.DnsSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s DNS settings. + + .. 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 domains_v1 + + def sample_configure_dns_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]): + The request object. Request for the ``ConfigureDnsSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + dns_settings (google.cloud.domains_v1.types.DnsSettings): + Fields of the ``DnsSettings`` to update. + This corresponds to the ``dns_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the name servers are being updated for an existing + Custom DNS configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains + DNS configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, dns_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureDnsSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureDnsSettingsRequest): + request = domains.ConfigureDnsSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if dns_settings is not None: + request.dns_settings = dns_settings + 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.configure_dns_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_contact_settings(self, + request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + contact_settings: Optional[domains.ContactSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + .. 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 domains_v1 + + def sample_configure_contact_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]): + The request object. Request for the ``ConfigureContactSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact_settings (google.cloud.domains_v1.types.ContactSettings): + Fields of the ``ContactSettings`` to update. + This corresponds to the ``contact_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the registrant contact is being updated, the + ``update_mask`` is ``"registrant_contact"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, contact_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureContactSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureContactSettingsRequest): + request = domains.ConfigureContactSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if contact_settings is not None: + request.contact_settings = contact_settings + 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.configure_contact_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def export_registration(self, + request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1 + + def sample_export_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]): + The request object. Request for the ``ExportRegistration`` method. + name (str): + Required. The name of the ``Registration`` to export, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ExportRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ExportRegistrationRequest): + request = domains.ExportRegistrationRequest(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.export_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_registration(self, + request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1 + + def sample_delete_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]): + The request object. Request for the ``DeleteRegistration`` method. + name (str): + Required. The name of the ``Registration`` to delete, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.DeleteRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.DeleteRegistrationRequest): + request = domains.DeleteRegistrationRequest(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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def retrieve_authorization_code(self, + request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1 + + def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveAuthorizationCodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveAuthorizationCodeRequest): + request = domains.RetrieveAuthorizationCodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_authorization_code] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def reset_authorization_code(self, + request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1 + + def sample_reset_authorization_code(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.reset_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]): + The request object. Request for the ``ResetAuthorizationCode`` method. + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ResetAuthorizationCodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ResetAuthorizationCodeRequest): + request = domains.ResetAuthorizationCodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.reset_authorization_code] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "DomainsClient": + 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__) + + +__all__ = ( + "DomainsClient", +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py new file mode 100644 index 0000000..b29d0e6 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py @@ -0,0 +1,139 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.domains_v1.types import domains + + +class ListRegistrationsPager: + """A pager for iterating through ``list_registrations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``registrations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRegistrations`` requests and continue to iterate + through the ``registrations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` + 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[..., domains.ListRegistrationsResponse], + request: domains.ListRegistrationsRequest, + response: domains.ListRegistrationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.domains_v1.types.ListRegistrationsRequest): + The initial request object. + response (google.cloud.domains_v1.types.ListRegistrationsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = domains.ListRegistrationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[domains.ListRegistrationsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[domains.Registration]: + for page in self.pages: + yield from page.registrations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRegistrationsAsyncPager: + """A pager for iterating through ``list_registrations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``registrations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRegistrations`` requests and continue to iterate + through the ``registrations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` + 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[domains.ListRegistrationsResponse]], + request: domains.ListRegistrationsRequest, + response: domains.ListRegistrationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.domains_v1.types.ListRegistrationsRequest): + The initial request object. + response (google.cloud.domains_v1.types.ListRegistrationsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = domains.ListRegistrationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[domains.ListRegistrationsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[domains.Registration]: + async def async_generator(): + async for page in self.pages: + for response in page.registrations: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py new file mode 100644 index 0000000..8648a03 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import DomainsTransport +from .grpc import DomainsGrpcTransport +from .grpc_asyncio import DomainsGrpcAsyncIOTransport +from .rest import DomainsRestTransport +from .rest import DomainsRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[DomainsTransport]] +_transport_registry['grpc'] = DomainsGrpcTransport +_transport_registry['grpc_asyncio'] = DomainsGrpcAsyncIOTransport +_transport_registry['rest'] = DomainsRestTransport + +__all__ = ( + 'DomainsTransport', + 'DomainsGrpcTransport', + 'DomainsGrpcAsyncIOTransport', + 'DomainsRestTransport', + 'DomainsRestInterceptor', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py new file mode 100644 index 0000000..a354941 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py @@ -0,0 +1,351 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.domains_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.domains_v1.types import domains +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class DomainsTransport(abc.ABC): + """Abstract transport class for Domains.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'domains.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.search_domains: gapic_v1.method.wrap_method( + self.search_domains, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_register_parameters: gapic_v1.method.wrap_method( + self.retrieve_register_parameters, + default_timeout=None, + client_info=client_info, + ), + self.register_domain: gapic_v1.method.wrap_method( + self.register_domain, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_transfer_parameters: gapic_v1.method.wrap_method( + self.retrieve_transfer_parameters, + default_timeout=None, + client_info=client_info, + ), + self.transfer_domain: gapic_v1.method.wrap_method( + self.transfer_domain, + default_timeout=None, + client_info=client_info, + ), + self.list_registrations: gapic_v1.method.wrap_method( + self.list_registrations, + default_timeout=None, + client_info=client_info, + ), + self.get_registration: gapic_v1.method.wrap_method( + self.get_registration, + default_timeout=None, + client_info=client_info, + ), + self.update_registration: gapic_v1.method.wrap_method( + self.update_registration, + default_timeout=None, + client_info=client_info, + ), + self.configure_management_settings: gapic_v1.method.wrap_method( + self.configure_management_settings, + default_timeout=None, + client_info=client_info, + ), + self.configure_dns_settings: gapic_v1.method.wrap_method( + self.configure_dns_settings, + default_timeout=None, + client_info=client_info, + ), + self.configure_contact_settings: gapic_v1.method.wrap_method( + self.configure_contact_settings, + default_timeout=None, + client_info=client_info, + ), + self.export_registration: gapic_v1.method.wrap_method( + self.export_registration, + default_timeout=None, + client_info=client_info, + ), + self.delete_registration: gapic_v1.method.wrap_method( + self.delete_registration, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_authorization_code: gapic_v1.method.wrap_method( + self.retrieve_authorization_code, + default_timeout=None, + client_info=client_info, + ), + self.reset_authorization_code: gapic_v1.method.wrap_method( + self.reset_authorization_code, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + Union[ + domains.SearchDomainsResponse, + Awaitable[domains.SearchDomainsResponse] + ]]: + raise NotImplementedError() + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + Union[ + domains.RetrieveRegisterParametersResponse, + Awaitable[domains.RetrieveRegisterParametersResponse] + ]]: + raise NotImplementedError() + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + Union[ + domains.RetrieveTransferParametersResponse, + Awaitable[domains.RetrieveTransferParametersResponse] + ]]: + raise NotImplementedError() + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + Union[ + domains.ListRegistrationsResponse, + Awaitable[domains.ListRegistrationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + Union[ + domains.Registration, + Awaitable[domains.Registration] + ]]: + raise NotImplementedError() + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + Union[ + domains.AuthorizationCode, + Awaitable[domains.AuthorizationCode] + ]]: + raise NotImplementedError() + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + Union[ + domains.AuthorizationCode, + Awaitable[domains.AuthorizationCode] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'DomainsTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py new file mode 100644 index 0000000..90a617c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py @@ -0,0 +1,742 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.domains_v1.types import domains +from google.longrunning import operations_pb2 # type: ignore +from .base import DomainsTransport, DEFAULT_CLIENT_INFO + + +class DomainsGrpcTransport(DomainsTransport): + """gRPC backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + domains.SearchDomainsResponse]: + r"""Return a callable for the search domains method over gRPC. + + Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + Returns: + Callable[[~.SearchDomainsRequest], + ~.SearchDomainsResponse]: + 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_domains' not in self._stubs: + self._stubs['search_domains'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/SearchDomains', + request_serializer=domains.SearchDomainsRequest.serialize, + response_deserializer=domains.SearchDomainsResponse.deserialize, + ) + return self._stubs['search_domains'] + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + domains.RetrieveRegisterParametersResponse]: + r"""Return a callable for the retrieve register parameters method over gRPC. + + Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + Returns: + Callable[[~.RetrieveRegisterParametersRequest], + ~.RetrieveRegisterParametersResponse]: + 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 'retrieve_register_parameters' not in self._stubs: + self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveRegisterParameters', + request_serializer=domains.RetrieveRegisterParametersRequest.serialize, + response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, + ) + return self._stubs['retrieve_register_parameters'] + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + operations_pb2.Operation]: + r"""Return a callable for the register domain method over gRPC. + + Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + Returns: + Callable[[~.RegisterDomainRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_domain' not in self._stubs: + self._stubs['register_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RegisterDomain', + request_serializer=domains.RegisterDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['register_domain'] + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + domains.RetrieveTransferParametersResponse]: + r"""Return a callable for the retrieve transfer parameters method over gRPC. + + Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + Returns: + Callable[[~.RetrieveTransferParametersRequest], + ~.RetrieveTransferParametersResponse]: + 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 'retrieve_transfer_parameters' not in self._stubs: + self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveTransferParameters', + request_serializer=domains.RetrieveTransferParametersRequest.serialize, + response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, + ) + return self._stubs['retrieve_transfer_parameters'] + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + operations_pb2.Operation]: + r"""Return a callable for the transfer domain method over gRPC. + + Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + Returns: + Callable[[~.TransferDomainRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'transfer_domain' not in self._stubs: + self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/TransferDomain', + request_serializer=domains.TransferDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['transfer_domain'] + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + domains.ListRegistrationsResponse]: + r"""Return a callable for the list registrations method over gRPC. + + Lists the ``Registration`` resources in a project. + + Returns: + Callable[[~.ListRegistrationsRequest], + ~.ListRegistrationsResponse]: + 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_registrations' not in self._stubs: + self._stubs['list_registrations'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ListRegistrations', + request_serializer=domains.ListRegistrationsRequest.serialize, + response_deserializer=domains.ListRegistrationsResponse.deserialize, + ) + return self._stubs['list_registrations'] + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + domains.Registration]: + r"""Return a callable for the get registration method over gRPC. + + Gets the details of a ``Registration`` resource. + + Returns: + Callable[[~.GetRegistrationRequest], + ~.Registration]: + 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_registration' not in self._stubs: + self._stubs['get_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/GetRegistration', + request_serializer=domains.GetRegistrationRequest.serialize, + response_deserializer=domains.Registration.deserialize, + ) + return self._stubs['get_registration'] + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the update registration method over gRPC. + + Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + Returns: + Callable[[~.UpdateRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_registration' not in self._stubs: + self._stubs['update_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/UpdateRegistration', + request_serializer=domains.UpdateRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_registration'] + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure management settings method over gRPC. + + Updates a ``Registration``'s management settings. + + Returns: + Callable[[~.ConfigureManagementSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_management_settings' not in self._stubs: + self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureManagementSettings', + request_serializer=domains.ConfigureManagementSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_management_settings'] + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure dns settings method over gRPC. + + Updates a ``Registration``'s DNS settings. + + Returns: + Callable[[~.ConfigureDnsSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_dns_settings' not in self._stubs: + self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureDnsSettings', + request_serializer=domains.ConfigureDnsSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_dns_settings'] + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure contact settings method over gRPC. + + Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + Returns: + Callable[[~.ConfigureContactSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_contact_settings' not in self._stubs: + self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureContactSettings', + request_serializer=domains.ConfigureContactSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_contact_settings'] + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the export registration method over gRPC. + + Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.ExportRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'export_registration' not in self._stubs: + self._stubs['export_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ExportRegistration', + request_serializer=domains.ExportRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['export_registration'] + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete registration method over gRPC. + + Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.DeleteRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_registration' not in self._stubs: + self._stubs['delete_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/DeleteRegistration', + request_serializer=domains.DeleteRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_registration'] + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + domains.AuthorizationCode]: + r"""Return a callable for the retrieve authorization code method over gRPC. + + Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.RetrieveAuthorizationCodeRequest], + ~.AuthorizationCode]: + 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 'retrieve_authorization_code' not in self._stubs: + self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveAuthorizationCode', + request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['retrieve_authorization_code'] + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + domains.AuthorizationCode]: + r"""Return a callable for the reset authorization code method over gRPC. + + Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.ResetAuthorizationCodeRequest], + ~.AuthorizationCode]: + 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 'reset_authorization_code' not in self._stubs: + self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ResetAuthorizationCode', + request_serializer=domains.ResetAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['reset_authorization_code'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'DomainsGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py new file mode 100644 index 0000000..a6c305f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py @@ -0,0 +1,741 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.domains_v1.types import domains +from google.longrunning import operations_pb2 # type: ignore +from .base import DomainsTransport, DEFAULT_CLIENT_INFO +from .grpc import DomainsGrpcTransport + + +class DomainsGrpcAsyncIOTransport(DomainsTransport): + """gRPC AsyncIO backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + Awaitable[domains.SearchDomainsResponse]]: + r"""Return a callable for the search domains method over gRPC. + + Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + Returns: + Callable[[~.SearchDomainsRequest], + Awaitable[~.SearchDomainsResponse]]: + 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_domains' not in self._stubs: + self._stubs['search_domains'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/SearchDomains', + request_serializer=domains.SearchDomainsRequest.serialize, + response_deserializer=domains.SearchDomainsResponse.deserialize, + ) + return self._stubs['search_domains'] + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + Awaitable[domains.RetrieveRegisterParametersResponse]]: + r"""Return a callable for the retrieve register parameters method over gRPC. + + Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + Returns: + Callable[[~.RetrieveRegisterParametersRequest], + Awaitable[~.RetrieveRegisterParametersResponse]]: + 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 'retrieve_register_parameters' not in self._stubs: + self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveRegisterParameters', + request_serializer=domains.RetrieveRegisterParametersRequest.serialize, + response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, + ) + return self._stubs['retrieve_register_parameters'] + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the register domain method over gRPC. + + Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + Returns: + Callable[[~.RegisterDomainRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_domain' not in self._stubs: + self._stubs['register_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RegisterDomain', + request_serializer=domains.RegisterDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['register_domain'] + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + Awaitable[domains.RetrieveTransferParametersResponse]]: + r"""Return a callable for the retrieve transfer parameters method over gRPC. + + Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + Returns: + Callable[[~.RetrieveTransferParametersRequest], + Awaitable[~.RetrieveTransferParametersResponse]]: + 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 'retrieve_transfer_parameters' not in self._stubs: + self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveTransferParameters', + request_serializer=domains.RetrieveTransferParametersRequest.serialize, + response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, + ) + return self._stubs['retrieve_transfer_parameters'] + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the transfer domain method over gRPC. + + Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + Returns: + Callable[[~.TransferDomainRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'transfer_domain' not in self._stubs: + self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/TransferDomain', + request_serializer=domains.TransferDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['transfer_domain'] + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + Awaitable[domains.ListRegistrationsResponse]]: + r"""Return a callable for the list registrations method over gRPC. + + Lists the ``Registration`` resources in a project. + + Returns: + Callable[[~.ListRegistrationsRequest], + Awaitable[~.ListRegistrationsResponse]]: + 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_registrations' not in self._stubs: + self._stubs['list_registrations'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ListRegistrations', + request_serializer=domains.ListRegistrationsRequest.serialize, + response_deserializer=domains.ListRegistrationsResponse.deserialize, + ) + return self._stubs['list_registrations'] + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + Awaitable[domains.Registration]]: + r"""Return a callable for the get registration method over gRPC. + + Gets the details of a ``Registration`` resource. + + Returns: + Callable[[~.GetRegistrationRequest], + Awaitable[~.Registration]]: + 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_registration' not in self._stubs: + self._stubs['get_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/GetRegistration', + request_serializer=domains.GetRegistrationRequest.serialize, + response_deserializer=domains.Registration.deserialize, + ) + return self._stubs['get_registration'] + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update registration method over gRPC. + + Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + Returns: + Callable[[~.UpdateRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_registration' not in self._stubs: + self._stubs['update_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/UpdateRegistration', + request_serializer=domains.UpdateRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_registration'] + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure management settings method over gRPC. + + Updates a ``Registration``'s management settings. + + Returns: + Callable[[~.ConfigureManagementSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_management_settings' not in self._stubs: + self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureManagementSettings', + request_serializer=domains.ConfigureManagementSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_management_settings'] + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure dns settings method over gRPC. + + Updates a ``Registration``'s DNS settings. + + Returns: + Callable[[~.ConfigureDnsSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_dns_settings' not in self._stubs: + self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureDnsSettings', + request_serializer=domains.ConfigureDnsSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_dns_settings'] + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure contact settings method over gRPC. + + Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + Returns: + Callable[[~.ConfigureContactSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_contact_settings' not in self._stubs: + self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ConfigureContactSettings', + request_serializer=domains.ConfigureContactSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_contact_settings'] + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the export registration method over gRPC. + + Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.ExportRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'export_registration' not in self._stubs: + self._stubs['export_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ExportRegistration', + request_serializer=domains.ExportRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['export_registration'] + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete registration method over gRPC. + + Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.DeleteRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_registration' not in self._stubs: + self._stubs['delete_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/DeleteRegistration', + request_serializer=domains.DeleteRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_registration'] + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + Awaitable[domains.AuthorizationCode]]: + r"""Return a callable for the retrieve authorization code method over gRPC. + + Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.RetrieveAuthorizationCodeRequest], + Awaitable[~.AuthorizationCode]]: + 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 'retrieve_authorization_code' not in self._stubs: + self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/RetrieveAuthorizationCode', + request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['retrieve_authorization_code'] + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + Awaitable[domains.AuthorizationCode]]: + r"""Return a callable for the reset authorization code method over gRPC. + + Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.ResetAuthorizationCodeRequest], + Awaitable[~.AuthorizationCode]]: + 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 'reset_authorization_code' not in self._stubs: + self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1.Domains/ResetAuthorizationCode', + request_serializer=domains.ResetAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['reset_authorization_code'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'DomainsGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py new file mode 100644 index 0000000..7b20c71 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py @@ -0,0 +1,1976 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.domains_v1.types import domains +from google.longrunning import operations_pb2 # type: ignore + +from .base import DomainsTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class DomainsRestInterceptor: + """Interceptor for Domains. + + 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 DomainsRestTransport. + + .. code-block:: python + class MyCustomDomainsInterceptor(DomainsRestInterceptor): + def pre_configure_contact_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_contact_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_configure_dns_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_dns_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_configure_management_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_management_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_export_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_export_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_registrations(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_registrations(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_domain(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_domain(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_reset_authorization_code(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_reset_authorization_code(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_authorization_code(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_authorization_code(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_register_parameters(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_register_parameters(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_transfer_parameters(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_transfer_parameters(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_domains(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_domains(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_transfer_domain(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_transfer_domain(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_registration(self, response): + logging.log(f"Received response: {response}") + return response + + transport = DomainsRestTransport(interceptor=MyCustomDomainsInterceptor()) + client = DomainsClient(transport=transport) + + + """ + def pre_configure_contact_settings(self, request: domains.ConfigureContactSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureContactSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_contact_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_contact_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_contact_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_configure_dns_settings(self, request: domains.ConfigureDnsSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureDnsSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_dns_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_dns_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_dns_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_configure_management_settings(self, request: domains.ConfigureManagementSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureManagementSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_management_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_management_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_management_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_delete_registration(self, request: domains.DeleteRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.DeleteRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_delete_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_export_registration(self, request: domains.ExportRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ExportRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for export_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_export_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for export_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_get_registration(self, request: domains.GetRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.GetRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_get_registration(self, response: domains.Registration) -> domains.Registration: + """Post-rpc interceptor for get_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_list_registrations(self, request: domains.ListRegistrationsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ListRegistrationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_registrations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_list_registrations(self, response: domains.ListRegistrationsResponse) -> domains.ListRegistrationsResponse: + """Post-rpc interceptor for list_registrations + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_register_domain(self, request: domains.RegisterDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RegisterDomainRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_domain + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_register_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for register_domain + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_reset_authorization_code(self, request: domains.ResetAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ResetAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for reset_authorization_code + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_reset_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: + """Post-rpc interceptor for reset_authorization_code + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_authorization_code(self, request: domains.RetrieveAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_authorization_code + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: + """Post-rpc interceptor for retrieve_authorization_code + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_register_parameters(self, request: domains.RetrieveRegisterParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveRegisterParametersRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_register_parameters + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_register_parameters(self, response: domains.RetrieveRegisterParametersResponse) -> domains.RetrieveRegisterParametersResponse: + """Post-rpc interceptor for retrieve_register_parameters + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_transfer_parameters(self, request: domains.RetrieveTransferParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveTransferParametersRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_transfer_parameters + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_transfer_parameters(self, response: domains.RetrieveTransferParametersResponse) -> domains.RetrieveTransferParametersResponse: + """Post-rpc interceptor for retrieve_transfer_parameters + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_search_domains(self, request: domains.SearchDomainsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.SearchDomainsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_domains + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_search_domains(self, response: domains.SearchDomainsResponse) -> domains.SearchDomainsResponse: + """Post-rpc interceptor for search_domains + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_transfer_domain(self, request: domains.TransferDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.TransferDomainRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for transfer_domain + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_transfer_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for transfer_domain + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_update_registration(self, request: domains.UpdateRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.UpdateRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_update_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class DomainsRestStub: + _session: AuthorizedSession + _host: str + _interceptor: DomainsRestInterceptor + + +class DomainsRestTransport(DomainsTransport): + """REST backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.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[DomainsRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or DomainsRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*}/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _ConfigureContactSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureContactSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureContactSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure contact + settings method over HTTP. + + Args: + request (~.domains.ConfigureContactSettingsRequest): + The request object. Request for the ``ConfigureContactSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_contact_settings(request, metadata) + pb_request = domains.ConfigureContactSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_contact_settings(resp) + return resp + + class _ConfigureDnsSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureDnsSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureDnsSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure dns settings method over HTTP. + + Args: + request (~.domains.ConfigureDnsSettingsRequest): + The request object. Request for the ``ConfigureDnsSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_dns_settings(request, metadata) + pb_request = domains.ConfigureDnsSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_dns_settings(resp) + return resp + + class _ConfigureManagementSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureManagementSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureManagementSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure management + settings method over HTTP. + + Args: + request (~.domains.ConfigureManagementSettingsRequest): + The request object. Request for the ``ConfigureManagementSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_management_settings(request, metadata) + pb_request = domains.ConfigureManagementSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_management_settings(resp) + return resp + + class _DeleteRegistration(DomainsRestStub): + def __hash__(self): + return hash("DeleteRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.DeleteRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete registration method over HTTP. + + Args: + request (~.domains.DeleteRegistrationRequest): + The request object. Request for the ``DeleteRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/registrations/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_registration(request, metadata) + pb_request = domains.DeleteRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_registration(resp) + return resp + + class _ExportRegistration(DomainsRestStub): + def __hash__(self): + return hash("ExportRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ExportRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the export registration method over HTTP. + + Args: + request (~.domains.ExportRegistrationRequest): + The request object. Request for the ``ExportRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{name=projects/*/locations/*/registrations/*}:export', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_export_registration(request, metadata) + pb_request = domains.ExportRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_export_registration(resp) + return resp + + class _GetRegistration(DomainsRestStub): + def __hash__(self): + return hash("GetRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.GetRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.Registration: + r"""Call the get registration method over HTTP. + + Args: + request (~.domains.GetRegistrationRequest): + The request object. Request for the ``GetRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.Registration: + The ``Registration`` resource facilitates managing and + configuring domain name registrations. + + There are several ways to create a new ``Registration`` + resource: + + To create a new ``Registration`` resource, find a + suitable domain name by calling the ``SearchDomains`` + method with a query to see available domain name + options. After choosing a name, call + ``RetrieveRegisterParameters`` to ensure availability + and obtain information like pricing, which is needed to + build a call to ``RegisterDomain``. + + Another way to create a new ``Registration`` is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the domain + for transfer and retrieve the domain's transfer + authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the + domain is unlocked and to get values needed to build a + call to ``TransferDomain``. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/registrations/*}', + }, + ] + request, metadata = self._interceptor.pre_get_registration(request, metadata) + pb_request = domains.GetRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.Registration() + pb_resp = domains.Registration.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_registration(resp) + return resp + + class _ListRegistrations(DomainsRestStub): + def __hash__(self): + return hash("ListRegistrations") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ListRegistrationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.ListRegistrationsResponse: + r"""Call the list registrations method over HTTP. + + Args: + request (~.domains.ListRegistrationsRequest): + The request object. Request for the ``ListRegistrations`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.ListRegistrationsResponse: + Response for the ``ListRegistrations`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/registrations', + }, + ] + request, metadata = self._interceptor.pre_list_registrations(request, metadata) + pb_request = domains.ListRegistrationsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.ListRegistrationsResponse() + pb_resp = domains.ListRegistrationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_registrations(resp) + return resp + + class _RegisterDomain(DomainsRestStub): + def __hash__(self): + return hash("RegisterDomain") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RegisterDomainRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the register domain method over HTTP. + + Args: + request (~.domains.RegisterDomainRequest): + The request object. Request for the ``RegisterDomain`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/registrations:register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_domain(request, metadata) + pb_request = domains.RegisterDomainRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_domain(resp) + return resp + + class _ResetAuthorizationCode(DomainsRestStub): + def __hash__(self): + return hash("ResetAuthorizationCode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ResetAuthorizationCodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.AuthorizationCode: + r"""Call the reset authorization code method over HTTP. + + Args: + request (~.domains.ResetAuthorizationCodeRequest): + The request object. Request for the ``ResetAuthorizationCode`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.AuthorizationCode: + Defines an authorization code. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_reset_authorization_code(request, metadata) + pb_request = domains.ResetAuthorizationCodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.AuthorizationCode() + pb_resp = domains.AuthorizationCode.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_reset_authorization_code(resp) + return resp + + class _RetrieveAuthorizationCode(DomainsRestStub): + def __hash__(self): + return hash("RetrieveAuthorizationCode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveAuthorizationCodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.AuthorizationCode: + r"""Call the retrieve authorization + code method over HTTP. + + Args: + request (~.domains.RetrieveAuthorizationCodeRequest): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.AuthorizationCode: + Defines an authorization code. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode', + }, + ] + request, metadata = self._interceptor.pre_retrieve_authorization_code(request, metadata) + pb_request = domains.RetrieveAuthorizationCodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.AuthorizationCode() + pb_resp = domains.AuthorizationCode.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_authorization_code(resp) + return resp + + class _RetrieveRegisterParameters(DomainsRestStub): + def __hash__(self): + return hash("RetrieveRegisterParameters") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "domainName" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveRegisterParametersRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Call the retrieve register + parameters method over HTTP. + + Args: + request (~.domains.RetrieveRegisterParametersRequest): + The request object. Request for the ``RetrieveRegisterParameters`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.RetrieveRegisterParametersResponse: + Response for the ``RetrieveRegisterParameters`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters', + }, + ] + request, metadata = self._interceptor.pre_retrieve_register_parameters(request, metadata) + pb_request = domains.RetrieveRegisterParametersRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.RetrieveRegisterParametersResponse() + pb_resp = domains.RetrieveRegisterParametersResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_register_parameters(resp) + return resp + + class _RetrieveTransferParameters(DomainsRestStub): + def __hash__(self): + return hash("RetrieveTransferParameters") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "domainName" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveTransferParametersRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.RetrieveTransferParametersResponse: + r"""Call the retrieve transfer + parameters method over HTTP. + + Args: + request (~.domains.RetrieveTransferParametersRequest): + The request object. Request for the ``RetrieveTransferParameters`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.RetrieveTransferParametersResponse: + Response for the ``RetrieveTransferParameters`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters', + }, + ] + request, metadata = self._interceptor.pre_retrieve_transfer_parameters(request, metadata) + pb_request = domains.RetrieveTransferParametersRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.RetrieveTransferParametersResponse() + pb_resp = domains.RetrieveTransferParametersResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_transfer_parameters(resp) + return resp + + class _SearchDomains(DomainsRestStub): + def __hash__(self): + return hash("SearchDomains") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "query" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.SearchDomainsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.SearchDomainsResponse: + r"""Call the search domains method over HTTP. + + Args: + request (~.domains.SearchDomainsRequest): + The request object. Request for the ``SearchDomains`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.SearchDomainsResponse: + Response for the ``SearchDomains`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{location=projects/*/locations/*}/registrations:searchDomains', + }, + ] + request, metadata = self._interceptor.pre_search_domains(request, metadata) + pb_request = domains.SearchDomainsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.SearchDomainsResponse() + pb_resp = domains.SearchDomainsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_domains(resp) + return resp + + class _TransferDomain(DomainsRestStub): + def __hash__(self): + return hash("TransferDomain") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.TransferDomainRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the transfer domain method over HTTP. + + Args: + request (~.domains.TransferDomainRequest): + The request object. Request for the ``TransferDomain`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/registrations:transfer', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_transfer_domain(request, metadata) + pb_request = domains.TransferDomainRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_transfer_domain(resp) + return resp + + class _UpdateRegistration(DomainsRestStub): + def __hash__(self): + return hash("UpdateRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "updateMask" : {}, } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.UpdateRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update registration method over HTTP. + + Args: + request (~.domains.UpdateRegistrationRequest): + The request object. Request for the ``UpdateRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{registration.name=projects/*/locations/*/registrations/*}', + 'body': 'registration', + }, + ] + request, metadata = self._interceptor.pre_update_registration(request, metadata) + pb_request = domains.UpdateRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_registration(resp) + return resp + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureContactSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureDnsSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureManagementSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ExportRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + domains.Registration]: + # 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._GetRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + domains.ListRegistrationsResponse]: + # 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._ListRegistrations(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDomain(self._session, self._host, self._interceptor) # type: ignore + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + domains.AuthorizationCode]: + # 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._ResetAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + domains.AuthorizationCode]: + # 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._RetrieveAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + domains.RetrieveRegisterParametersResponse]: + # 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._RetrieveRegisterParameters(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + domains.RetrieveTransferParametersResponse]: + # 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._RetrieveTransferParameters(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + domains.SearchDomainsResponse]: + # 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._SearchDomains(self._session, self._host, self._interceptor) # type: ignore + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._TransferDomain(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'DomainsRestTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py new file mode 100644 index 0000000..cb45e82 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py @@ -0,0 +1,82 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .domains import ( + AuthorizationCode, + ConfigureContactSettingsRequest, + ConfigureDnsSettingsRequest, + ConfigureManagementSettingsRequest, + ContactSettings, + DeleteRegistrationRequest, + DnsSettings, + ExportRegistrationRequest, + GetRegistrationRequest, + ListRegistrationsRequest, + ListRegistrationsResponse, + ManagementSettings, + OperationMetadata, + RegisterDomainRequest, + RegisterParameters, + Registration, + ResetAuthorizationCodeRequest, + RetrieveAuthorizationCodeRequest, + RetrieveRegisterParametersRequest, + RetrieveRegisterParametersResponse, + RetrieveTransferParametersRequest, + RetrieveTransferParametersResponse, + SearchDomainsRequest, + SearchDomainsResponse, + TransferDomainRequest, + TransferParameters, + UpdateRegistrationRequest, + ContactNotice, + ContactPrivacy, + DomainNotice, + TransferLockState, +) + +__all__ = ( + 'AuthorizationCode', + 'ConfigureContactSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureManagementSettingsRequest', + 'ContactSettings', + 'DeleteRegistrationRequest', + 'DnsSettings', + 'ExportRegistrationRequest', + 'GetRegistrationRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'ManagementSettings', + 'OperationMetadata', + 'RegisterDomainRequest', + 'RegisterParameters', + 'Registration', + 'ResetAuthorizationCodeRequest', + 'RetrieveAuthorizationCodeRequest', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'TransferDomainRequest', + 'TransferParameters', + 'UpdateRegistrationRequest', + 'ContactNotice', + 'ContactPrivacy', + 'DomainNotice', + 'TransferLockState', +) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py b/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py new file mode 100644 index 0000000..a066517 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py @@ -0,0 +1,1523 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from google.type import postal_address_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.domains.v1', + manifest={ + 'ContactPrivacy', + 'DomainNotice', + 'ContactNotice', + 'TransferLockState', + 'Registration', + 'ManagementSettings', + 'DnsSettings', + 'ContactSettings', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RegisterDomainRequest', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'TransferDomainRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'GetRegistrationRequest', + 'UpdateRegistrationRequest', + 'ConfigureManagementSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureContactSettingsRequest', + 'ExportRegistrationRequest', + 'DeleteRegistrationRequest', + 'RetrieveAuthorizationCodeRequest', + 'ResetAuthorizationCodeRequest', + 'RegisterParameters', + 'TransferParameters', + 'AuthorizationCode', + 'OperationMetadata', + }, +) + + +class ContactPrivacy(proto.Enum): + r"""Defines a set of possible contact privacy settings for a + ``Registration``. + + `ICANN `__ maintains the WHOIS database, a + publicly accessible mapping from domain name to contact information, + and requires that each domain name have an entry. Choose from these + options to control how much information in your ``ContactSettings`` + is published. + + Values: + CONTACT_PRIVACY_UNSPECIFIED (0): + The contact privacy settings are undefined. + PUBLIC_CONTACT_DATA (1): + All the data from ``ContactSettings`` is publicly available. + When setting this option, you must also provide a + ``PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT`` in the + ``contact_notices`` field of the request. + PRIVATE_CONTACT_DATA (2): + None of the data from ``ContactSettings`` is publicly + available. Instead, proxy contact data is published for your + domain. Email sent to the proxy email address is forwarded + to the registrant's email address. Cloud Domains provides + this privacy proxy service at no additional cost. + REDACTED_CONTACT_DATA (3): + Some data from ``ContactSettings`` is publicly available. + The actual information redacted depends on the domain. For + details, see `the registration privacy + article `__. + """ + CONTACT_PRIVACY_UNSPECIFIED = 0 + PUBLIC_CONTACT_DATA = 1 + PRIVATE_CONTACT_DATA = 2 + REDACTED_CONTACT_DATA = 3 + + +class DomainNotice(proto.Enum): + r"""Notices about special properties of certain domains. + + Values: + DOMAIN_NOTICE_UNSPECIFIED (0): + The notice is undefined. + HSTS_PRELOADED (1): + Indicates that the domain is preloaded on the HTTP Strict + Transport Security list in browsers. Serving a website on + such domain requires an SSL certificate. For details, see + `how to get an SSL + certificate `__. + """ + DOMAIN_NOTICE_UNSPECIFIED = 0 + HSTS_PRELOADED = 1 + + +class ContactNotice(proto.Enum): + r"""Notices related to contact information. + + Values: + CONTACT_NOTICE_UNSPECIFIED (0): + The notice is undefined. + PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1): + Required when setting the ``privacy`` field of + ``ContactSettings`` to ``PUBLIC_CONTACT_DATA``, which + exposes contact data publicly. + """ + CONTACT_NOTICE_UNSPECIFIED = 0 + PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT = 1 + + +class TransferLockState(proto.Enum): + r"""Possible states of a ``Registration``'s transfer lock. + + Values: + TRANSFER_LOCK_STATE_UNSPECIFIED (0): + The state is unspecified. + UNLOCKED (1): + The domain is unlocked and can be transferred + to another registrar. + LOCKED (2): + The domain is locked and cannot be + transferred to another registrar. + """ + TRANSFER_LOCK_STATE_UNSPECIFIED = 0 + UNLOCKED = 1 + LOCKED = 2 + + +class Registration(proto.Message): + r"""The ``Registration`` resource facilitates managing and configuring + domain name registrations. + + There are several ways to create a new ``Registration`` resource: + + To create a new ``Registration`` resource, find a suitable domain + name by calling the ``SearchDomains`` method with a query to see + available domain name options. After choosing a name, call + ``RetrieveRegisterParameters`` to ensure availability and obtain + information like pricing, which is needed to build a call to + ``RegisterDomain``. + + Another way to create a new ``Registration`` is to transfer an + existing domain from another registrar. First, go to the current + registrar to unlock the domain for transfer and retrieve the + domain's transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to + ``TransferDomain``. + + Attributes: + name (str): + Output only. Name of the ``Registration`` resource, in the + format + ``projects/*/locations/*/registrations/``. + domain_name (str): + Required. Immutable. The domain name. Unicode + domain names must be expressed in Punycode + format. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The creation timestamp of the ``Registration`` + resource. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The expiration timestamp of the + ``Registration``. + state (google.cloud.domains_v1.types.Registration.State): + Output only. The state of the ``Registration`` + issues (MutableSequence[google.cloud.domains_v1.types.Registration.Issue]): + Output only. The set of issues with the ``Registration`` + that require attention. + labels (MutableMapping[str, str]): + Set of labels associated with the ``Registration``. + management_settings (google.cloud.domains_v1.types.ManagementSettings): + Settings for management of the ``Registration``, including + renewal, billing, and transfer. You cannot update these with + the ``UpdateRegistration`` method. To update these settings, + use the ``ConfigureManagementSettings`` method. + dns_settings (google.cloud.domains_v1.types.DnsSettings): + Settings controlling the DNS configuration of the + ``Registration``. You cannot update these with the + ``UpdateRegistration`` method. To update these settings, use + the ``ConfigureDnsSettings`` method. + contact_settings (google.cloud.domains_v1.types.ContactSettings): + Required. Settings for contact information linked to the + ``Registration``. You cannot update these with the + ``UpdateRegistration`` method. To update these settings, use + the ``ConfigureContactSettings`` method. + pending_contact_settings (google.cloud.domains_v1.types.ContactSettings): + Output only. Pending contact settings for the + ``Registration``. Updates to the ``contact_settings`` field + that change its ``registrant_contact`` or ``privacy`` fields + require email confirmation by the ``registrant_contact`` + before taking effect. This field is set only if there are + pending updates to the ``contact_settings`` that have not + been confirmed. To confirm the changes, the + ``registrant_contact`` must follow the instructions in the + email they receive. + supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): + Output only. Set of options for the + ``contact_settings.privacy`` field that this + ``Registration`` supports. + """ + class State(proto.Enum): + r"""Possible states of a ``Registration``. + + Values: + STATE_UNSPECIFIED (0): + The state is undefined. + REGISTRATION_PENDING (1): + The domain is being registered. + REGISTRATION_FAILED (2): + The domain registration failed. You can + delete resources in this state to allow + registration to be retried. + TRANSFER_PENDING (3): + The domain is being transferred from another + registrar to Cloud Domains. + TRANSFER_FAILED (4): + The attempt to transfer the domain from + another registrar to Cloud Domains failed. You + can delete resources in this state and retry the + transfer. + ACTIVE (6): + The domain is registered and operational. The + domain renews automatically as long as it + remains in this state. + SUSPENDED (7): + The domain is suspended and inoperative. For more details, + see the ``issues`` field. + EXPORTED (8): + The domain is no longer managed with Cloud Domains. It may + have been transferred to another registrar or exported for + management in `Google Domains `__. + You can no longer update it with this API, and information + shown about it may be stale. Domains in this state are not + automatically renewed by Cloud Domains. + """ + STATE_UNSPECIFIED = 0 + REGISTRATION_PENDING = 1 + REGISTRATION_FAILED = 2 + TRANSFER_PENDING = 3 + TRANSFER_FAILED = 4 + ACTIVE = 6 + SUSPENDED = 7 + EXPORTED = 8 + + class Issue(proto.Enum): + r"""Possible issues with a ``Registration`` that require attention. + + Values: + ISSUE_UNSPECIFIED (0): + The issue is undefined. + CONTACT_SUPPORT (1): + Contact the Cloud Support team to resolve a + problem with this domain. + UNVERIFIED_EMAIL (2): + `ICANN `__ requires verification of the + email address in the ``Registration``'s + ``contact_settings.registrant_contact`` field. To verify the + email address, follow the instructions in the email the + ``registrant_contact`` receives following registration. If + you do not complete email verification within 15 days of + registration, the domain is suspended. To resend the + verification email, call ConfigureContactSettings and + provide the current ``registrant_contact.email``. + """ + ISSUE_UNSPECIFIED = 0 + CONTACT_SUPPORT = 1 + UNVERIFIED_EMAIL = 2 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + domain_name: str = proto.Field( + proto.STRING, + number=2, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + expire_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + state: State = proto.Field( + proto.ENUM, + number=7, + enum=State, + ) + issues: MutableSequence[Issue] = proto.RepeatedField( + proto.ENUM, + number=8, + enum=Issue, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=9, + ) + management_settings: 'ManagementSettings' = proto.Field( + proto.MESSAGE, + number=10, + message='ManagementSettings', + ) + dns_settings: 'DnsSettings' = proto.Field( + proto.MESSAGE, + number=11, + message='DnsSettings', + ) + contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=12, + message='ContactSettings', + ) + pending_contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=13, + message='ContactSettings', + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=14, + enum='ContactPrivacy', + ) + + +class ManagementSettings(proto.Message): + r"""Defines renewal, billing, and transfer settings for a + ``Registration``. + + Attributes: + renewal_method (google.cloud.domains_v1.types.ManagementSettings.RenewalMethod): + Output only. The renewal method for this ``Registration``. + transfer_lock_state (google.cloud.domains_v1.types.TransferLockState): + Controls whether the domain can be + transferred to another registrar. + """ + class RenewalMethod(proto.Enum): + r"""Defines how the ``Registration`` is renewed. + + Values: + RENEWAL_METHOD_UNSPECIFIED (0): + The renewal method is undefined. + AUTOMATIC_RENEWAL (1): + The domain is automatically renewed each year . + + To disable automatic renewals, delete the resource by + calling ``DeleteRegistration`` or export it by calling + ``ExportRegistration``. + MANUAL_RENEWAL (2): + The domain must be explicitly renewed each year before its + ``expire_time``. This option is only available when the + ``Registration`` is in state ``EXPORTED``. + + To manage the domain's current billing and renewal settings, + go to `Google Domains `__. + """ + RENEWAL_METHOD_UNSPECIFIED = 0 + AUTOMATIC_RENEWAL = 1 + MANUAL_RENEWAL = 2 + + renewal_method: RenewalMethod = proto.Field( + proto.ENUM, + number=3, + enum=RenewalMethod, + ) + transfer_lock_state: 'TransferLockState' = proto.Field( + proto.ENUM, + number=4, + enum='TransferLockState', + ) + + +class DnsSettings(proto.Message): + r"""Defines the DNS configuration of a ``Registration``, including name + servers, DNSSEC, and glue records. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + custom_dns (google.cloud.domains_v1.types.DnsSettings.CustomDns): + An arbitrary DNS provider identified by its + name servers. + + This field is a member of `oneof`_ ``dns_provider``. + google_domains_dns (google.cloud.domains_v1.types.DnsSettings.GoogleDomainsDns): + The free DNS zone provided by `Google + Domains `__. + + This field is a member of `oneof`_ ``dns_provider``. + glue_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.GlueRecord]): + The list of glue records for this ``Registration``. Commonly + empty. + """ + class DsState(proto.Enum): + r"""The publication state of DS records for a ``Registration``. + + Values: + DS_STATE_UNSPECIFIED (0): + DS state is unspecified. + DS_RECORDS_UNPUBLISHED (1): + DNSSEC is disabled for this domain. No DS + records for this domain are published in the + parent DNS zone. + DS_RECORDS_PUBLISHED (2): + DNSSEC is enabled for this domain. Appropriate DS records + for this domain are published in the parent DNS zone. This + option is valid only if the DNS zone referenced in the + ``Registration``'s ``dns_provider`` field is already + DNSSEC-signed. + """ + DS_STATE_UNSPECIFIED = 0 + DS_RECORDS_UNPUBLISHED = 1 + DS_RECORDS_PUBLISHED = 2 + + class CustomDns(proto.Message): + r"""Configuration for an arbitrary DNS provider. + + Attributes: + name_servers (MutableSequence[str]): + Required. A list of name servers that store + the DNS zone for this domain. Each name server + is a domain name, with Unicode domain names + expressed in Punycode format. + ds_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]): + The list of DS records for this domain, which + are used to enable DNSSEC. The domain's DNS + provider can provide the values to set here. If + this field is empty, DNSSEC is disabled. + """ + + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='DnsSettings.DsRecord', + ) + + class GoogleDomainsDns(proto.Message): + r"""Configuration for using the free DNS zone provided by Google Domains + as a ``Registration``'s ``dns_provider``. You cannot configure the + DNS zone itself using the API. To configure the DNS zone, go to + `Google Domains `__. + + Attributes: + name_servers (MutableSequence[str]): + Output only. A list of name servers that + store the DNS zone for this domain. Each name + server is a domain name, with Unicode domain + names expressed in Punycode format. This field + is automatically populated with the name servers + assigned to the Google Domains DNS zone. + ds_state (google.cloud.domains_v1.types.DnsSettings.DsState): + Required. The state of DS records for this + domain. Used to enable or disable automatic + DNSSEC. + ds_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]): + Output only. The list of DS records published for this + domain. The list is automatically populated when + ``ds_state`` is ``DS_RECORDS_PUBLISHED``, otherwise it + remains empty. + """ + + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + ds_state: 'DnsSettings.DsState' = proto.Field( + proto.ENUM, + number=2, + enum='DnsSettings.DsState', + ) + ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='DnsSettings.DsRecord', + ) + + class DsRecord(proto.Message): + r"""Defines a Delegation Signer (DS) record, which is needed to + enable DNSSEC for a domain. It contains a digest (hash) of a + DNSKEY record that must be present in the domain's DNS zone. + + Attributes: + key_tag (int): + The key tag of the record. Must be set in + range 0 -- 65535. + algorithm (google.cloud.domains_v1.types.DnsSettings.DsRecord.Algorithm): + The algorithm used to generate the referenced + DNSKEY. + digest_type (google.cloud.domains_v1.types.DnsSettings.DsRecord.DigestType): + The hash function used to generate the digest + of the referenced DNSKEY. + digest (str): + The digest generated from the referenced + DNSKEY. + """ + class Algorithm(proto.Enum): + r"""List of algorithms used to create a DNSKEY. Certain + algorithms are not supported for particular domains. + + Values: + ALGORITHM_UNSPECIFIED (0): + The algorithm is unspecified. + RSAMD5 (1): + RSA/MD5. Cannot be used for new deployments. + DH (2): + Diffie-Hellman. Cannot be used for new + deployments. + DSA (3): + DSA/SHA1. Not recommended for new + deployments. + ECC (4): + ECC. Not recommended for new deployments. + RSASHA1 (5): + RSA/SHA-1. Not recommended for new + deployments. + DSANSEC3SHA1 (6): + DSA-NSEC3-SHA1. Not recommended for new + deployments. + RSASHA1NSEC3SHA1 (7): + RSA/SHA1-NSEC3-SHA1. Not recommended for new + deployments. + RSASHA256 (8): + RSA/SHA-256. + RSASHA512 (10): + RSA/SHA-512. + ECCGOST (12): + GOST R 34.10-2001. + ECDSAP256SHA256 (13): + ECDSA Curve P-256 with SHA-256. + ECDSAP384SHA384 (14): + ECDSA Curve P-384 with SHA-384. + ED25519 (15): + Ed25519. + ED448 (16): + Ed448. + INDIRECT (252): + Reserved for Indirect Keys. Cannot be used + for new deployments. + PRIVATEDNS (253): + Private algorithm. Cannot be used for new + deployments. + PRIVATEOID (254): + Private algorithm OID. Cannot be used for new + deployments. + """ + ALGORITHM_UNSPECIFIED = 0 + RSAMD5 = 1 + DH = 2 + DSA = 3 + ECC = 4 + RSASHA1 = 5 + DSANSEC3SHA1 = 6 + RSASHA1NSEC3SHA1 = 7 + RSASHA256 = 8 + RSASHA512 = 10 + ECCGOST = 12 + ECDSAP256SHA256 = 13 + ECDSAP384SHA384 = 14 + ED25519 = 15 + ED448 = 16 + INDIRECT = 252 + PRIVATEDNS = 253 + PRIVATEOID = 254 + + class DigestType(proto.Enum): + r"""List of hash functions that may have been used to generate a + digest of a DNSKEY. + + Values: + DIGEST_TYPE_UNSPECIFIED (0): + The DigestType is unspecified. + SHA1 (1): + SHA-1. Not recommended for new deployments. + SHA256 (2): + SHA-256. + GOST3411 (3): + GOST R 34.11-94. + SHA384 (4): + SHA-384. + """ + DIGEST_TYPE_UNSPECIFIED = 0 + SHA1 = 1 + SHA256 = 2 + GOST3411 = 3 + SHA384 = 4 + + key_tag: int = proto.Field( + proto.INT32, + number=1, + ) + algorithm: 'DnsSettings.DsRecord.Algorithm' = proto.Field( + proto.ENUM, + number=2, + enum='DnsSettings.DsRecord.Algorithm', + ) + digest_type: 'DnsSettings.DsRecord.DigestType' = proto.Field( + proto.ENUM, + number=3, + enum='DnsSettings.DsRecord.DigestType', + ) + digest: str = proto.Field( + proto.STRING, + number=4, + ) + + class GlueRecord(proto.Message): + r"""Defines a host on your domain that is a DNS name server for your + domain and/or other domains. Glue records are a way of making the IP + address of a name server known, even when it serves DNS queries for + its parent domain. For example, when ``ns.example.com`` is a name + server for ``example.com``, the host ``ns.example.com`` must have a + glue record to break the circular DNS reference. + + Attributes: + host_name (str): + Required. Domain name of the host in Punycode + format. + ipv4_addresses (MutableSequence[str]): + List of IPv4 addresses corresponding to this host in the + standard decimal format (e.g. ``198.51.100.1``). At least + one of ``ipv4_address`` and ``ipv6_address`` must be set. + ipv6_addresses (MutableSequence[str]): + List of IPv6 addresses corresponding to this host in the + standard hexadecimal format (e.g. ``2001:db8::``). At least + one of ``ipv4_address`` and ``ipv6_address`` must be set. + """ + + host_name: str = proto.Field( + proto.STRING, + number=1, + ) + ipv4_addresses: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + ipv6_addresses: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + custom_dns: CustomDns = proto.Field( + proto.MESSAGE, + number=1, + oneof='dns_provider', + message=CustomDns, + ) + google_domains_dns: GoogleDomainsDns = proto.Field( + proto.MESSAGE, + number=2, + oneof='dns_provider', + message=GoogleDomainsDns, + ) + glue_records: MutableSequence[GlueRecord] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message=GlueRecord, + ) + + +class ContactSettings(proto.Message): + r"""Defines the contact information associated with a ``Registration``. + + `ICANN `__ requires all domain names to have + associated contact information. The ``registrant_contact`` is + considered the domain's legal owner, and often the other contacts + are identical. + + Attributes: + privacy (google.cloud.domains_v1.types.ContactPrivacy): + Required. Privacy setting for the contacts associated with + the ``Registration``. + registrant_contact (google.cloud.domains_v1.types.ContactSettings.Contact): + Required. The registrant contact for the ``Registration``. + + *Caution: Anyone with access to this email address, phone + number, and/or postal address can take control of the + domain.* + + *Warning: For new ``Registration``\ s, the registrant + receives an email confirmation that they must complete + within 15 days to avoid domain suspension.* + admin_contact (google.cloud.domains_v1.types.ContactSettings.Contact): + Required. The administrative contact for the + ``Registration``. + technical_contact (google.cloud.domains_v1.types.ContactSettings.Contact): + Required. The technical contact for the ``Registration``. + """ + + class Contact(proto.Message): + r"""Details required for a contact associated with a ``Registration``. + + Attributes: + postal_address (google.type.postal_address_pb2.PostalAddress): + Required. Postal address of the contact. + email (str): + Required. Email address of the contact. + phone_number (str): + Required. Phone number of the contact in international + format. For example, ``"+1-800-555-0123"``. + fax_number (str): + Fax number of the contact in international format. For + example, ``"+1-800-555-0123"``. + """ + + postal_address: postal_address_pb2.PostalAddress = proto.Field( + proto.MESSAGE, + number=1, + message=postal_address_pb2.PostalAddress, + ) + email: str = proto.Field( + proto.STRING, + number=2, + ) + phone_number: str = proto.Field( + proto.STRING, + number=3, + ) + fax_number: str = proto.Field( + proto.STRING, + number=4, + ) + + privacy: 'ContactPrivacy' = proto.Field( + proto.ENUM, + number=1, + enum='ContactPrivacy', + ) + registrant_contact: Contact = proto.Field( + proto.MESSAGE, + number=2, + message=Contact, + ) + admin_contact: Contact = proto.Field( + proto.MESSAGE, + number=3, + message=Contact, + ) + technical_contact: Contact = proto.Field( + proto.MESSAGE, + number=4, + message=Contact, + ) + + +class SearchDomainsRequest(proto.Message): + r"""Request for the ``SearchDomains`` method. + + Attributes: + query (str): + Required. String used to search for available + domain names. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + query: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchDomainsResponse(proto.Message): + r"""Response for the ``SearchDomains`` method. + + Attributes: + register_parameters (MutableSequence[google.cloud.domains_v1.types.RegisterParameters]): + Results of the domain name search. + """ + + register_parameters: MutableSequence['RegisterParameters'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RegisterParameters', + ) + + +class RetrieveRegisterParametersRequest(proto.Message): + r"""Request for the ``RetrieveRegisterParameters`` method. + + Attributes: + domain_name (str): + Required. The domain name. Unicode domain + names must be expressed in Punycode format. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RetrieveRegisterParametersResponse(proto.Message): + r"""Response for the ``RetrieveRegisterParameters`` method. + + Attributes: + register_parameters (google.cloud.domains_v1.types.RegisterParameters): + Parameters to use when calling the ``RegisterDomain`` + method. + """ + + register_parameters: 'RegisterParameters' = proto.Field( + proto.MESSAGE, + number=1, + message='RegisterParameters', + ) + + +class RegisterDomainRequest(proto.Message): + r"""Request for the ``RegisterDomain`` method. + + Attributes: + parent (str): + Required. The parent resource of the ``Registration``. Must + be in the format ``projects/*/locations/*``. + registration (google.cloud.domains_v1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + domain_notices (MutableSequence[google.cloud.domains_v1.types.DomainNotice]): + The list of domain notices that you acknowledge. Call + ``RetrieveRegisterParameters`` to see the notices that need + acknowledgement. + contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): + The list of contact notices that the caller acknowledges. + The notices needed here depend on the values specified in + ``registration.contact_settings``. + yearly_price (google.type.money_pb2.Money): + Required. Yearly price to register or renew + the domain. The value that should be put here + can be obtained from RetrieveRegisterParameters + or SearchDomains calls. + validate_only (bool): + When true, only validation is performed, without actually + registering the domain. Follows: + https://cloud.google.com/apis/design/design_patterns#request_validation + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=2, + message='Registration', + ) + domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='DomainNotice', + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='ContactNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=5, + message=money_pb2.Money, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=6, + ) + + +class RetrieveTransferParametersRequest(proto.Message): + r"""Request for the ``RetrieveTransferParameters`` method. + + Attributes: + domain_name (str): + Required. The domain name. Unicode domain + names must be expressed in Punycode format. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RetrieveTransferParametersResponse(proto.Message): + r"""Response for the ``RetrieveTransferParameters`` method. + + Attributes: + transfer_parameters (google.cloud.domains_v1.types.TransferParameters): + Parameters to use when calling the ``TransferDomain`` + method. + """ + + transfer_parameters: 'TransferParameters' = proto.Field( + proto.MESSAGE, + number=1, + message='TransferParameters', + ) + + +class TransferDomainRequest(proto.Message): + r"""Request for the ``TransferDomain`` method. + + Attributes: + parent (str): + Required. The parent resource of the ``Registration``. Must + be in the format ``projects/*/locations/*``. + registration (google.cloud.domains_v1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to import + the domain's current DNS configuration from its current + registrar. Use this option only if you are sure that the + domain's current DNS service does not cease upon transfer, + as is often the case for DNS services provided for free by + the registrar. + contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): + The list of contact notices that you acknowledge. The + notices needed here depend on the values specified in + ``registration.contact_settings``. + yearly_price (google.type.money_pb2.Money): + Required. Acknowledgement of the price to transfer or renew + the domain for one year. Call ``RetrieveTransferParameters`` + to obtain the price, which you must acknowledge. + authorization_code (google.cloud.domains_v1.types.AuthorizationCode): + The domain's transfer authorization code. You + can obtain this from the domain's current + registrar. + validate_only (bool): + Validate the request without actually + transferring the domain. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=2, + message='Registration', + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='ContactNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=4, + message=money_pb2.Money, + ) + authorization_code: 'AuthorizationCode' = proto.Field( + proto.MESSAGE, + number=5, + message='AuthorizationCode', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=6, + ) + + +class ListRegistrationsRequest(proto.Message): + r"""Request for the ``ListRegistrations`` method. + + Attributes: + parent (str): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + page_size (int): + Maximum number of results to return. + page_token (str): + When set to the ``next_page_token`` from a prior response, + provides the next page of results. + filter (str): + Filter expression to restrict the ``Registration``\ s + returned. + + The expression must specify the field name, a comparison + operator, and the value that you want to use for filtering. + The value must be a string, a number, a boolean, or an enum + value. The comparison operator should be one of =, !=, >, <, + >=, <=, or : for prefix or wildcard matches. + + For example, to filter to a specific domain name, use an + expression like ``domainName="example.com"``. You can also + check for the existence of a field; for example, to find + domains using custom DNS settings, use an expression like + ``dnsSettings.customDns:*``. + + You can also create compound filters by combining + expressions with the ``AND`` and ``OR`` operators. For + example, to find domains that are suspended or have specific + issues flagged, use an expression like + ``(state=SUSPENDED) OR (issue:*)``. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListRegistrationsResponse(proto.Message): + r"""Response for the ``ListRegistrations`` method. + + Attributes: + registrations (MutableSequence[google.cloud.domains_v1.types.Registration]): + A list of ``Registration``\ s. + next_page_token (str): + When present, there are more results to retrieve. Set + ``page_token`` to this value on a subsequent call to get the + next page of results. + """ + + @property + def raw_page(self): + return self + + registrations: MutableSequence['Registration'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Registration', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRegistrationRequest(proto.Message): + r"""Request for the ``GetRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to get, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateRegistrationRequest(proto.Message): + r"""Request for the ``UpdateRegistration`` method. + + Attributes: + registration (google.cloud.domains_v1.types.Registration): + Fields of the ``Registration`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the labels + are being updated, the ``update_mask`` is ``"labels"``. + """ + + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=1, + message='Registration', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class ConfigureManagementSettingsRequest(proto.Message): + r"""Request for the ``ConfigureManagementSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose management + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + management_settings (google.cloud.domains_v1.types.ManagementSettings): + Fields of the ``ManagementSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the transfer + lock is being updated, the ``update_mask`` is + ``"transfer_lock_state"``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + management_settings: 'ManagementSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='ManagementSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + + +class ConfigureDnsSettingsRequest(proto.Message): + r"""Request for the ``ConfigureDnsSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + dns_settings (google.cloud.domains_v1.types.DnsSettings): + Fields of the ``DnsSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the name + servers are being updated for an existing Custom DNS + configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains DNS + configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + validate_only (bool): + Validate the request without actually + updating the DNS settings. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + dns_settings: 'DnsSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='DnsSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ConfigureContactSettingsRequest(proto.Message): + r"""Request for the ``ConfigureContactSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + contact_settings (google.cloud.domains_v1.types.ContactSettings): + Fields of the ``ContactSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the + registrant contact is being updated, the ``update_mask`` is + ``"registrant_contact"``. + contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): + The list of contact notices that the caller acknowledges. + The notices needed here depend on the values specified in + ``contact_settings``. + validate_only (bool): + Validate the request without actually + updating the contact settings. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='ContactSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='ContactNotice', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=5, + ) + + +class ExportRegistrationRequest(proto.Message): + r"""Request for the ``ExportRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to export, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteRegistrationRequest(proto.Message): + r"""Request for the ``DeleteRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to delete, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class RetrieveAuthorizationCodeRequest(proto.Message): + r"""Request for the ``RetrieveAuthorizationCode`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ResetAuthorizationCodeRequest(proto.Message): + r"""Request for the ``ResetAuthorizationCode`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + + +class RegisterParameters(proto.Message): + r"""Parameters required to register a new domain. + + Attributes: + domain_name (str): + The domain name. Unicode domain names are + expressed in Punycode format. + availability (google.cloud.domains_v1.types.RegisterParameters.Availability): + Indicates whether the domain is available for registration. + This value is accurate when obtained by calling + ``RetrieveRegisterParameters``, but is approximate when + obtained by calling ``SearchDomains``. + supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): + Contact privacy options that the domain + supports. + domain_notices (MutableSequence[google.cloud.domains_v1.types.DomainNotice]): + Notices about special properties of the + domain. + yearly_price (google.type.money_pb2.Money): + Price to register or renew the domain for one + year. + """ + class Availability(proto.Enum): + r"""Possible availability states of a domain name. + + Values: + AVAILABILITY_UNSPECIFIED (0): + The availability is unspecified. + AVAILABLE (1): + The domain is available for registration. + UNAVAILABLE (2): + The domain is not available for registration. + Generally this means it is already registered to + another party. + UNSUPPORTED (3): + The domain is not currently supported by + Cloud Domains, but may be available elsewhere. + UNKNOWN (4): + Cloud Domains is unable to determine domain + availability, generally due to system + maintenance at the domain name registry. + """ + AVAILABILITY_UNSPECIFIED = 0 + AVAILABLE = 1 + UNAVAILABLE = 2 + UNSUPPORTED = 3 + UNKNOWN = 4 + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + availability: Availability = proto.Field( + proto.ENUM, + number=2, + enum=Availability, + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='ContactPrivacy', + ) + domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='DomainNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=5, + message=money_pb2.Money, + ) + + +class TransferParameters(proto.Message): + r"""Parameters required to transfer a domain from another + registrar. + + Attributes: + domain_name (str): + The domain name. Unicode domain names are + expressed in Punycode format. + current_registrar (str): + The registrar that currently manages the + domain. + name_servers (MutableSequence[str]): + The name servers that currently store the + configuration of the domain. + transfer_lock_state (google.cloud.domains_v1.types.TransferLockState): + Indicates whether the domain is protected by a transfer + lock. For a transfer to succeed, this must show + ``UNLOCKED``. To unlock a domain, go to its current + registrar. + supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): + Contact privacy options that the domain + supports. + yearly_price (google.type.money_pb2.Money): + Price to transfer or renew the domain for one + year. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + current_registrar: str = proto.Field( + proto.STRING, + number=2, + ) + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + transfer_lock_state: 'TransferLockState' = proto.Field( + proto.ENUM, + number=4, + enum='TransferLockState', + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=5, + enum='ContactPrivacy', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=6, + message=money_pb2.Money, + ) + + +class AuthorizationCode(proto.Message): + r"""Defines an authorization code. + + Attributes: + code (str): + The Authorization Code in ASCII. It can be + used to transfer the domain to or from another + registrar. + """ + + code: str = proto.Field( + proto.STRING, + number=1, + ) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of the long-running operation. Output + only. + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation finished running. + target (str): + Server-defined resource path for the target + of the operation. + verb (str): + Name of the verb executed by the operation. + status_detail (str): + Human-readable status of the operation, if + any. + api_version (str): + API version used to start the operation. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target: str = proto.Field( + proto.STRING, + number=3, + ) + verb: str = proto.Field( + proto.STRING, + number=4, + ) + status_detail: str = proto.Field( + proto.STRING, + number=5, + ) + api_version: str = proto.Field( + proto.STRING, + number=6, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..0358546 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/domains_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py new file mode 100644 index 0000000..585c2f3 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureContactSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureContactSettings_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 domains_v1 + + +async def sample_configure_contact_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureContactSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py new file mode 100644 index 0000000..194933c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureContactSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureContactSettings_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 domains_v1 + + +def sample_configure_contact_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureContactSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py new file mode 100644 index 0000000..98ccae9 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureDnsSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureDnsSettings_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 domains_v1 + + +async def sample_configure_dns_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureDnsSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py new file mode 100644 index 0000000..111b4e6 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureDnsSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureDnsSettings_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 domains_v1 + + +def sample_configure_dns_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureDnsSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py new file mode 100644 index 0000000..ce082da --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureManagementSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureManagementSettings_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 domains_v1 + + +async def sample_configure_management_settings(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureManagementSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py new file mode 100644 index 0000000..834a0fc --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureManagementSettings +# 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-domains + + +# [START domains_v1_generated_Domains_ConfigureManagementSettings_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 domains_v1 + + +def sample_configure_management_settings(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ConfigureManagementSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py new file mode 100644 index 0000000..2cf9e84 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_DeleteRegistration_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 domains_v1 + + +async def sample_delete_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_DeleteRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py new file mode 100644 index 0000000..468a20a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_DeleteRegistration_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 domains_v1 + + +def sample_delete_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_DeleteRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py new file mode 100644 index 0000000..8cb7dc7 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ExportRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_ExportRegistration_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 domains_v1 + + +async def sample_export_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ExportRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py new file mode 100644 index 0000000..28868cb --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ExportRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_ExportRegistration_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 domains_v1 + + +def sample_export_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ExportRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py new file mode 100644 index 0000000..d339699 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_GetRegistration_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 domains_v1 + + +async def sample_get_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_registration(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_GetRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py new file mode 100644 index 0000000..1f05063 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_GetRegistration_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 domains_v1 + + +def sample_get_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = client.get_registration(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_GetRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py new file mode 100644 index 0000000..935036d --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRegistrations +# 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-domains + + +# [START domains_v1_generated_Domains_ListRegistrations_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 domains_v1 + + +async def sample_list_registrations(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END domains_v1_generated_Domains_ListRegistrations_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py new file mode 100644 index 0000000..30d1f85 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRegistrations +# 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-domains + + +# [START domains_v1_generated_Domains_ListRegistrations_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 domains_v1 + + +def sample_list_registrations(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END domains_v1_generated_Domains_ListRegistrations_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py new file mode 100644 index 0000000..62d1fa4 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDomain +# 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-domains + + +# [START domains_v1_generated_Domains_RegisterDomain_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 domains_v1 + + +async def sample_register_domain(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RegisterDomain_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py new file mode 100644 index 0000000..e9ddd16 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDomain +# 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-domains + + +# [START domains_v1_generated_Domains_RegisterDomain_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 domains_v1 + + +def sample_register_domain(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RegisterDomain_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py new file mode 100644 index 0000000..c1c87d7 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ResetAuthorizationCode +# 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-domains + + +# [START domains_v1_generated_Domains_ResetAuthorizationCode_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 domains_v1 + + +async def sample_reset_authorization_code(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.reset_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ResetAuthorizationCode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py new file mode 100644 index 0000000..985ce1b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ResetAuthorizationCode +# 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-domains + + +# [START domains_v1_generated_Domains_ResetAuthorizationCode_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 domains_v1 + + +def sample_reset_authorization_code(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.reset_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_ResetAuthorizationCode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py new file mode 100644 index 0000000..5e62fdf --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveAuthorizationCode +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1 + + +async def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveAuthorizationCode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py new file mode 100644 index 0000000..b8976f4 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveAuthorizationCode +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1 + + +def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveAuthorizationCode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py new file mode 100644 index 0000000..416d8d0 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveRegisterParameters +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveRegisterParameters_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 domains_v1 + + +async def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveRegisterParameters_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py new file mode 100644 index 0000000..1195433 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveRegisterParameters +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveRegisterParameters_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 domains_v1 + + +def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveRegisterParameters_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py new file mode 100644 index 0000000..7fbb86d --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveTransferParameters +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveTransferParameters_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 domains_v1 + + +async def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveTransferParameters_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py new file mode 100644 index 0000000..5ed9f4c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveTransferParameters +# 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-domains + + +# [START domains_v1_generated_Domains_RetrieveTransferParameters_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 domains_v1 + + +def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_RetrieveTransferParameters_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py new file mode 100644 index 0000000..276f24a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchDomains +# 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-domains + + +# [START domains_v1_generated_Domains_SearchDomains_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 domains_v1 + + +async def sample_search_domains(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = await client.search_domains(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_SearchDomains_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py new file mode 100644 index 0000000..1ccb1f0 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchDomains +# 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-domains + + +# [START domains_v1_generated_Domains_SearchDomains_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 domains_v1 + + +def sample_search_domains(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = client.search_domains(request=request) + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_SearchDomains_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py new file mode 100644 index 0000000..cb5b269 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TransferDomain +# 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-domains + + +# [START domains_v1_generated_Domains_TransferDomain_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 domains_v1 + + +async def sample_transfer_domain(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_TransferDomain_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py new file mode 100644 index 0000000..213561a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TransferDomain +# 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-domains + + +# [START domains_v1_generated_Domains_TransferDomain_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 domains_v1 + + +def sample_transfer_domain(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_TransferDomain_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py new file mode 100644 index 0000000..47c24db --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_UpdateRegistration_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 domains_v1 + + +async def sample_update_registration(): + # Create a client + client = domains_v1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_UpdateRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py new file mode 100644 index 0000000..4718109 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRegistration +# 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-domains + + +# [START domains_v1_generated_Domains_UpdateRegistration_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 domains_v1 + + +def sample_update_registration(): + # Create a client + client = domains_v1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1_generated_Domains_UpdateRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json new file mode 100644 index 0000000..5384077 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json @@ -0,0 +1,2550 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.domains.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-domains", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_contact_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureContactSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureContactSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureContactSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "contact_settings", + "type": "google.cloud.domains_v1.types.ContactSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_contact_settings" + }, + "description": "Sample for ConfigureContactSettings", + "file": "domains_v1_generated_domains_configure_contact_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureContactSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_contact_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.configure_contact_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureContactSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureContactSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureContactSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "contact_settings", + "type": "google.cloud.domains_v1.types.ContactSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_contact_settings" + }, + "description": "Sample for ConfigureContactSettings", + "file": "domains_v1_generated_domains_configure_contact_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureContactSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_contact_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_dns_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureDnsSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureDnsSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureDnsSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "dns_settings", + "type": "google.cloud.domains_v1.types.DnsSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_dns_settings" + }, + "description": "Sample for ConfigureDnsSettings", + "file": "domains_v1_generated_domains_configure_dns_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureDnsSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_dns_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.configure_dns_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureDnsSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureDnsSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureDnsSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "dns_settings", + "type": "google.cloud.domains_v1.types.DnsSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_dns_settings" + }, + "description": "Sample for ConfigureDnsSettings", + "file": "domains_v1_generated_domains_configure_dns_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureDnsSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_dns_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_management_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureManagementSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureManagementSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureManagementSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "management_settings", + "type": "google.cloud.domains_v1.types.ManagementSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_management_settings" + }, + "description": "Sample for ConfigureManagementSettings", + "file": "domains_v1_generated_domains_configure_management_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureManagementSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_management_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.configure_management_settings", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ConfigureManagementSettings", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureManagementSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ConfigureManagementSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "management_settings", + "type": "google.cloud.domains_v1.types.ManagementSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_management_settings" + }, + "description": "Sample for ConfigureManagementSettings", + "file": "domains_v1_generated_domains_configure_management_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ConfigureManagementSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_configure_management_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.delete_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.DeleteRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "DeleteRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.DeleteRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_registration" + }, + "description": "Sample for DeleteRegistration", + "file": "domains_v1_generated_domains_delete_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_DeleteRegistration_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_delete_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.delete_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.DeleteRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "DeleteRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.DeleteRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_registration" + }, + "description": "Sample for DeleteRegistration", + "file": "domains_v1_generated_domains_delete_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_DeleteRegistration_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_delete_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.export_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ExportRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ExportRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ExportRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "export_registration" + }, + "description": "Sample for ExportRegistration", + "file": "domains_v1_generated_domains_export_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ExportRegistration_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_export_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.export_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ExportRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ExportRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ExportRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "export_registration" + }, + "description": "Sample for ExportRegistration", + "file": "domains_v1_generated_domains_export_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ExportRegistration_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_export_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.get_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.GetRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "GetRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.GetRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.Registration", + "shortName": "get_registration" + }, + "description": "Sample for GetRegistration", + "file": "domains_v1_generated_domains_get_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_GetRegistration_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": "domains_v1_generated_domains_get_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.get_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.GetRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "GetRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.GetRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.Registration", + "shortName": "get_registration" + }, + "description": "Sample for GetRegistration", + "file": "domains_v1_generated_domains_get_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_GetRegistration_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": "domains_v1_generated_domains_get_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.list_registrations", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ListRegistrations", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ListRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ListRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager", + "shortName": "list_registrations" + }, + "description": "Sample for ListRegistrations", + "file": "domains_v1_generated_domains_list_registrations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ListRegistrations_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": "domains_v1_generated_domains_list_registrations_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.list_registrations", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ListRegistrations", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ListRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ListRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager", + "shortName": "list_registrations" + }, + "description": "Sample for ListRegistrations", + "file": "domains_v1_generated_domains_list_registrations_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ListRegistrations_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": "domains_v1_generated_domains_list_registrations_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.register_domain", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RegisterDomain", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RegisterDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RegisterDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "register_domain" + }, + "description": "Sample for RegisterDomain", + "file": "domains_v1_generated_domains_register_domain_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RegisterDomain_async", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_register_domain_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.register_domain", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RegisterDomain", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RegisterDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RegisterDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "register_domain" + }, + "description": "Sample for RegisterDomain", + "file": "domains_v1_generated_domains_register_domain_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RegisterDomain_sync", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_register_domain_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.reset_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ResetAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ResetAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ResetAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.AuthorizationCode", + "shortName": "reset_authorization_code" + }, + "description": "Sample for ResetAuthorizationCode", + "file": "domains_v1_generated_domains_reset_authorization_code_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ResetAuthorizationCode_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": "domains_v1_generated_domains_reset_authorization_code_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.reset_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1.Domains.ResetAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "ResetAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.ResetAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.AuthorizationCode", + "shortName": "reset_authorization_code" + }, + "description": "Sample for ResetAuthorizationCode", + "file": "domains_v1_generated_domains_reset_authorization_code_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_ResetAuthorizationCode_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": "domains_v1_generated_domains_reset_authorization_code_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.AuthorizationCode", + "shortName": "retrieve_authorization_code" + }, + "description": "Sample for RetrieveAuthorizationCode", + "file": "domains_v1_generated_domains_retrieve_authorization_code_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1_generated_domains_retrieve_authorization_code_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.AuthorizationCode", + "shortName": "retrieve_authorization_code" + }, + "description": "Sample for RetrieveAuthorizationCode", + "file": "domains_v1_generated_domains_retrieve_authorization_code_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1_generated_domains_retrieve_authorization_code_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_register_parameters", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveRegisterParameters", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveRegisterParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveRegisterParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.RetrieveRegisterParametersResponse", + "shortName": "retrieve_register_parameters" + }, + "description": "Sample for RetrieveRegisterParameters", + "file": "domains_v1_generated_domains_retrieve_register_parameters_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1_generated_domains_retrieve_register_parameters_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_register_parameters", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveRegisterParameters", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveRegisterParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveRegisterParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.RetrieveRegisterParametersResponse", + "shortName": "retrieve_register_parameters" + }, + "description": "Sample for RetrieveRegisterParameters", + "file": "domains_v1_generated_domains_retrieve_register_parameters_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1_generated_domains_retrieve_register_parameters_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_transfer_parameters", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveTransferParameters", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveTransferParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveTransferParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.RetrieveTransferParametersResponse", + "shortName": "retrieve_transfer_parameters" + }, + "description": "Sample for RetrieveTransferParameters", + "file": "domains_v1_generated_domains_retrieve_transfer_parameters_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveTransferParameters_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": "domains_v1_generated_domains_retrieve_transfer_parameters_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_transfer_parameters", + "method": { + "fullName": "google.cloud.domains.v1.Domains.RetrieveTransferParameters", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveTransferParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.RetrieveTransferParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.RetrieveTransferParametersResponse", + "shortName": "retrieve_transfer_parameters" + }, + "description": "Sample for RetrieveTransferParameters", + "file": "domains_v1_generated_domains_retrieve_transfer_parameters_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_RetrieveTransferParameters_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": "domains_v1_generated_domains_retrieve_transfer_parameters_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.search_domains", + "method": { + "fullName": "google.cloud.domains.v1.Domains.SearchDomains", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "SearchDomains" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.SearchDomainsRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.SearchDomainsResponse", + "shortName": "search_domains" + }, + "description": "Sample for SearchDomains", + "file": "domains_v1_generated_domains_search_domains_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_SearchDomains_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": "domains_v1_generated_domains_search_domains_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.search_domains", + "method": { + "fullName": "google.cloud.domains.v1.Domains.SearchDomains", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "SearchDomains" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.SearchDomainsRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1.types.SearchDomainsResponse", + "shortName": "search_domains" + }, + "description": "Sample for SearchDomains", + "file": "domains_v1_generated_domains_search_domains_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_SearchDomains_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": "domains_v1_generated_domains_search_domains_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.transfer_domain", + "method": { + "fullName": "google.cloud.domains.v1.Domains.TransferDomain", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "TransferDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.TransferDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "authorization_code", + "type": "google.cloud.domains_v1.types.AuthorizationCode" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "transfer_domain" + }, + "description": "Sample for TransferDomain", + "file": "domains_v1_generated_domains_transfer_domain_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_TransferDomain_async", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_transfer_domain_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.transfer_domain", + "method": { + "fullName": "google.cloud.domains.v1.Domains.TransferDomain", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "TransferDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.TransferDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "authorization_code", + "type": "google.cloud.domains_v1.types.AuthorizationCode" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "transfer_domain" + }, + "description": "Sample for TransferDomain", + "file": "domains_v1_generated_domains_transfer_domain_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_TransferDomain_sync", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_transfer_domain_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1.DomainsAsyncClient.update_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.UpdateRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "UpdateRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.UpdateRegistrationRequest" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_registration" + }, + "description": "Sample for UpdateRegistration", + "file": "domains_v1_generated_domains_update_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_UpdateRegistration_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_update_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1.DomainsClient.update_registration", + "method": { + "fullName": "google.cloud.domains.v1.Domains.UpdateRegistration", + "service": { + "fullName": "google.cloud.domains.v1.Domains", + "shortName": "Domains" + }, + "shortName": "UpdateRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1.types.UpdateRegistrationRequest" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1.types.Registration" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_registration" + }, + "description": "Sample for UpdateRegistration", + "file": "domains_v1_generated_domains_update_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1_generated_Domains_UpdateRegistration_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1_generated_domains_update_registration_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py new file mode 100644 index 0000000..39c812d --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py @@ -0,0 +1,190 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class domainsCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'configure_contact_settings': ('registration', 'update_mask', 'contact_settings', 'contact_notices', 'validate_only', ), + 'configure_dns_settings': ('registration', 'update_mask', 'dns_settings', 'validate_only', ), + 'configure_management_settings': ('registration', 'update_mask', 'management_settings', ), + 'delete_registration': ('name', ), + 'export_registration': ('name', ), + 'get_registration': ('name', ), + 'list_registrations': ('parent', 'page_size', 'page_token', 'filter', ), + 'register_domain': ('parent', 'registration', 'yearly_price', 'domain_notices', 'contact_notices', 'validate_only', ), + 'reset_authorization_code': ('registration', ), + 'retrieve_authorization_code': ('registration', ), + 'retrieve_register_parameters': ('domain_name', 'location', ), + 'retrieve_transfer_parameters': ('domain_name', 'location', ), + 'search_domains': ('query', 'location', ), + 'transfer_domain': ('parent', 'registration', 'yearly_price', 'contact_notices', 'authorization_code', 'validate_only', ), + 'update_registration': ('update_mask', 'registration', ), + } + + 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=domainsCallTransformer(), +): + """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 domains client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..70be905 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-domains' + + +description = "Google Cloud Domains API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/domains/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-domains" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py new file mode 100644 index 0000000..8f61ecc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py @@ -0,0 +1,8728 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.domains_v1.services.domains import DomainsAsyncClient +from google.cloud.domains_v1.services.domains import DomainsClient +from google.cloud.domains_v1.services.domains import pagers +from google.cloud.domains_v1.services.domains import transports +from google.cloud.domains_v1.types import domains +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from google.type import postal_address_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert DomainsClient._get_default_mtls_endpoint(None) is None + assert DomainsClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (DomainsClient, "grpc"), + (DomainsAsyncClient, "grpc_asyncio"), + (DomainsClient, "rest"), +]) +def test_domains_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 == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://domains.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.DomainsGrpcTransport, "grpc"), + (transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.DomainsRestTransport, "rest"), +]) +def test_domains_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", [ + (DomainsClient, "grpc"), + (DomainsAsyncClient, "grpc_asyncio"), + (DomainsClient, "rest"), +]) +def test_domains_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 == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://domains.googleapis.com' + ) + + +def test_domains_client_get_transport_class(): + transport = DomainsClient.get_transport_class() + available_transports = [ + transports.DomainsGrpcTransport, + transports.DomainsRestTransport, + ] + assert transport in available_transports + + transport = DomainsClient.get_transport_class("grpc") + assert transport == transports.DomainsGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (DomainsClient, transports.DomainsRestTransport, "rest"), +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +def test_domains_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(DomainsClient, '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(DomainsClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", "true"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (DomainsClient, transports.DomainsGrpcTransport, "grpc", "false"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (DomainsClient, transports.DomainsRestTransport, "rest", "true"), + (DomainsClient, transports.DomainsRestTransport, "rest", "false"), +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_domains_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + DomainsClient, DomainsAsyncClient +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +def test_domains_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (DomainsClient, transports.DomainsRestTransport, "rest"), +]) +def test_domains_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (DomainsClient, transports.DomainsRestTransport, "rest", None), +]) +def test_domains_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_domains_client_client_options_from_dict(): + with mock.patch('google.cloud.domains_v1.services.domains.transports.DomainsGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = DomainsClient( + 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", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_domains_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "domains.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="domains.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + domains.SearchDomainsRequest, + dict, +]) +def test_search_domains(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse( + ) + response = client.search_domains(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +def test_search_domains_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + client.search_domains() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + +@pytest.mark.asyncio +async def test_search_domains_async(transport: str = 'grpc_asyncio', request_type=domains.SearchDomainsRequest): + client = DomainsAsyncClient( + 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_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse( + )) + response = await client.search_domains(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +@pytest.mark.asyncio +async def test_search_domains_async_from_dict(): + await test_search_domains_async(request_type=dict) + + +def test_search_domains_field_headers(): + client = DomainsClient( + 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 = domains.SearchDomainsRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + call.return_value = domains.SearchDomainsResponse() + client.search_domains(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_domains_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.SearchDomainsRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) + await client.search_domains(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_search_domains_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_domains( + location='location_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + + +def test_search_domains_flattened_error(): + client = DomainsClient( + 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_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + +@pytest.mark.asyncio +async def test_search_domains_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_domains( + location='location_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_search_domains_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveRegisterParametersRequest, + dict, +]) +def test_retrieve_register_parameters(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse( + ) + response = client.retrieve_register_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +def test_retrieve_register_parameters_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + client.retrieve_register_parameters() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveRegisterParametersRequest): + client = DomainsAsyncClient( + 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.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse( + )) + response = await client.retrieve_register_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_async_from_dict(): + await test_retrieve_register_parameters_async(request_type=dict) + + +def test_retrieve_register_parameters_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveRegisterParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + call.return_value = domains.RetrieveRegisterParametersResponse() + client.retrieve_register_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveRegisterParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) + await client.retrieve_register_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_retrieve_register_parameters_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_register_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + + +def test_retrieve_register_parameters_flattened_error(): + client = DomainsClient( + 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.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_register_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RegisterDomainRequest, + dict, +]) +def test_register_domain(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.register_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_register_domain_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + client.register_domain() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + +@pytest.mark.asyncio +async def test_register_domain_async(transport: str = 'grpc_asyncio', request_type=domains.RegisterDomainRequest): + client = DomainsAsyncClient( + 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.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.register_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_register_domain_async_from_dict(): + await test_register_domain_async(request_type=dict) + + +def test_register_domain_field_headers(): + client = DomainsClient( + 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 = domains.RegisterDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.register_domain(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_register_domain_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RegisterDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.register_domain(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_register_domain_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.register_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + + +def test_register_domain_flattened_error(): + client = DomainsClient( + 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.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + +@pytest.mark.asyncio +async def test_register_domain_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.register_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_register_domain_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveTransferParametersRequest, + dict, +]) +def test_retrieve_transfer_parameters(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse( + ) + response = client.retrieve_transfer_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +def test_retrieve_transfer_parameters_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + client.retrieve_transfer_parameters() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveTransferParametersRequest): + client = DomainsAsyncClient( + 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.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse( + )) + response = await client.retrieve_transfer_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_async_from_dict(): + await test_retrieve_transfer_parameters_async(request_type=dict) + + +def test_retrieve_transfer_parameters_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveTransferParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + call.return_value = domains.RetrieveTransferParametersResponse() + client.retrieve_transfer_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveTransferParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) + await client.retrieve_transfer_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_retrieve_transfer_parameters_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_transfer_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + + +def test_retrieve_transfer_parameters_flattened_error(): + client = DomainsClient( + 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.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_transfer_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.TransferDomainRequest, + dict, +]) +def test_transfer_domain(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.transfer_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_transfer_domain_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + client.transfer_domain() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + +@pytest.mark.asyncio +async def test_transfer_domain_async(transport: str = 'grpc_asyncio', request_type=domains.TransferDomainRequest): + client = DomainsAsyncClient( + 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.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.transfer_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_transfer_domain_async_from_dict(): + await test_transfer_domain_async(request_type=dict) + + +def test_transfer_domain_field_headers(): + client = DomainsClient( + 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 = domains.TransferDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.transfer_domain(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_transfer_domain_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.TransferDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.transfer_domain(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_transfer_domain_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.transfer_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + arg = args[0].authorization_code + mock_val = domains.AuthorizationCode(code='code_value') + assert arg == mock_val + + +def test_transfer_domain_flattened_error(): + client = DomainsClient( + 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.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + +@pytest.mark.asyncio +async def test_transfer_domain_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.transfer_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + arg = args[0].authorization_code + mock_val = domains.AuthorizationCode(code='code_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_transfer_domain_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ListRegistrationsRequest, + dict, +]) +def test_list_registrations(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_registrations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_registrations_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + client.list_registrations() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + +@pytest.mark.asyncio +async def test_list_registrations_async(transport: str = 'grpc_asyncio', request_type=domains.ListRegistrationsRequest): + client = DomainsAsyncClient( + 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_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_registrations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_registrations_async_from_dict(): + await test_list_registrations_async(request_type=dict) + + +def test_list_registrations_field_headers(): + client = DomainsClient( + 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 = domains.ListRegistrationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + call.return_value = domains.ListRegistrationsResponse() + client.list_registrations(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_registrations_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ListRegistrationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) + await client.list_registrations(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_registrations_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_registrations( + 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_registrations_flattened_error(): + client = DomainsClient( + 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_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_registrations_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_registrations( + 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_registrations_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + + +def test_list_registrations_pager(transport_name: str = "grpc"): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_registrations(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, domains.Registration) + for i in results) +def test_list_registrations_pages(transport_name: str = "grpc"): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + pages = list(client.list_registrations(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_registrations_async_pager(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_registrations(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, domains.Registration) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_registrations_async_pages(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_registrations(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + domains.GetRegistrationRequest, + dict, +]) +def test_get_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + ) + response = client.get_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +def test_get_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + client.get_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + +@pytest.mark.asyncio +async def test_get_registration_async(transport: str = 'grpc_asyncio', request_type=domains.GetRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + )) + response = await client.get_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +@pytest.mark.asyncio +async def test_get_registration_async_from_dict(): + await test_get_registration_async(request_type=dict) + + +def test_get_registration_field_headers(): + client = DomainsClient( + 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 = domains.GetRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + call.return_value = domains.Registration() + client.get_registration(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_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.GetRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) + await client.get_registration(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_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_registration( + 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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_registration( + 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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.UpdateRegistrationRequest, + dict, +]) +def test_update_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + client.update_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + +@pytest.mark.asyncio +async def test_update_registration_async(transport: str = 'grpc_asyncio', request_type=domains.UpdateRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_registration_async_from_dict(): + await test_update_registration_async(request_type=dict) + + +def test_update_registration_field_headers(): + client = DomainsClient( + 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 = domains.UpdateRegistrationRequest() + + request.registration.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_registration(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', + 'registration.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.UpdateRegistrationRequest() + + request.registration.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_registration(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', + 'registration.name=name_value', + ) in kw['metadata'] + + +def test_update_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_registration( + registration=domains.Registration(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].registration + mock_val = domains.Registration(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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_registration( + registration=domains.Registration(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].registration + mock_val = domains.Registration(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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureManagementSettingsRequest, + dict, +]) +def test_configure_management_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_management_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_management_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + client.configure_management_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_management_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureManagementSettingsRequest): + client = DomainsAsyncClient( + 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.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_management_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_management_settings_async_from_dict(): + await test_configure_management_settings_async(request_type=dict) + + +def test_configure_management_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureManagementSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_management_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_management_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureManagementSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_management_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_management_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_management_settings( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].management_settings + mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_configure_management_settings_flattened_error(): + client = DomainsClient( + 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.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_management_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_management_settings( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].management_settings + mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) + 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_configure_management_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureDnsSettingsRequest, + dict, +]) +def test_configure_dns_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_dns_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_dns_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + client.configure_dns_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_dns_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureDnsSettingsRequest): + client = DomainsAsyncClient( + 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.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_dns_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_dns_settings_async_from_dict(): + await test_configure_dns_settings_async(request_type=dict) + + +def test_configure_dns_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureDnsSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_dns_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_dns_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureDnsSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_dns_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_dns_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_dns_settings( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].dns_settings + mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error(): + client = DomainsClient( + 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.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_dns_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_dns_settings( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].dns_settings + mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureContactSettingsRequest, + dict, +]) +def test_configure_contact_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_contact_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_contact_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + client.configure_contact_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_contact_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureContactSettingsRequest): + client = DomainsAsyncClient( + 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.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_contact_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_contact_settings_async_from_dict(): + await test_configure_contact_settings_async(request_type=dict) + + +def test_configure_contact_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureContactSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_contact_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_contact_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureContactSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_contact_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_contact_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_contact_settings( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].contact_settings + mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_configure_contact_settings_flattened_error(): + client = DomainsClient( + 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.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_contact_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_contact_settings( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].contact_settings + mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) + 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_configure_contact_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ExportRegistrationRequest, + dict, +]) +def test_export_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.export_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_export_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + client.export_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + +@pytest.mark.asyncio +async def test_export_registration_async(transport: str = 'grpc_asyncio', request_type=domains.ExportRegistrationRequest): + client = DomainsAsyncClient( + 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.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.export_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_export_registration_async_from_dict(): + await test_export_registration_async(request_type=dict) + + +def test_export_registration_field_headers(): + client = DomainsClient( + 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 = domains.ExportRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.export_registration(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_export_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ExportRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.export_registration(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_export_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.export_registration( + 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_export_registration_flattened_error(): + client = DomainsClient( + 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.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_export_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.export_registration( + 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_export_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.DeleteRegistrationRequest, + dict, +]) +def test_delete_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + client.delete_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + +@pytest.mark.asyncio +async def test_delete_registration_async(transport: str = 'grpc_asyncio', request_type=domains.DeleteRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_registration_async_from_dict(): + await test_delete_registration_async(request_type=dict) + + +def test_delete_registration_field_headers(): + client = DomainsClient( + 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 = domains.DeleteRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_registration(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_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.DeleteRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_registration(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_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_registration( + 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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_registration( + 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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveAuthorizationCodeRequest, + dict, +]) +def test_retrieve_authorization_code(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode( + code='code_value', + ) + response = client.retrieve_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_retrieve_authorization_code_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + client.retrieve_authorization_code() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveAuthorizationCodeRequest): + client = DomainsAsyncClient( + 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.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( + code='code_value', + )) + response = await client.retrieve_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_async_from_dict(): + await test_retrieve_authorization_code_async(request_type=dict) + + +def test_retrieve_authorization_code_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + call.return_value = domains.AuthorizationCode() + client.retrieve_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + await client.retrieve_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_retrieve_authorization_code_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + + +def test_retrieve_authorization_code_flattened_error(): + client = DomainsClient( + 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.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ResetAuthorizationCodeRequest, + dict, +]) +def test_reset_authorization_code(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode( + code='code_value', + ) + response = client.reset_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_reset_authorization_code_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + client.reset_authorization_code() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + +@pytest.mark.asyncio +async def test_reset_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.ResetAuthorizationCodeRequest): + client = DomainsAsyncClient( + 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.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( + code='code_value', + )) + response = await client.reset_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +@pytest.mark.asyncio +async def test_reset_authorization_code_async_from_dict(): + await test_reset_authorization_code_async(request_type=dict) + + +def test_reset_authorization_code_field_headers(): + client = DomainsClient( + 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 = domains.ResetAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + call.return_value = domains.AuthorizationCode() + client.reset_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_reset_authorization_code_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ResetAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + await client.reset_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_reset_authorization_code_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.reset_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + + +def test_reset_authorization_code_flattened_error(): + client = DomainsClient( + 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.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + +@pytest.mark.asyncio +async def test_reset_authorization_code_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.reset_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_reset_authorization_code_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.SearchDomainsRequest, + dict, +]) +def test_search_domains_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.SearchDomainsResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.search_domains(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +def test_search_domains_rest_required_fields(request_type=domains.SearchDomainsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["query"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "query" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "query" in jsonified_request + assert jsonified_request["query"] == request_init["query"] + + jsonified_request["query"] = 'query_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("query", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "query" in jsonified_request + assert jsonified_request["query"] == 'query_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.SearchDomainsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.search_domains(request) + + expected_params = [ + ( + "query", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_domains_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_domains._get_unset_required_fields({}) + assert set(unset_fields) == (set(("query", )) & set(("query", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_domains_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_search_domains") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_search_domains") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.SearchDomainsRequest.pb(domains.SearchDomainsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.SearchDomainsResponse.to_json(domains.SearchDomainsResponse()) + + request = domains.SearchDomainsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.SearchDomainsResponse() + + client.search_domains(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_domains_rest_bad_request(transport: str = 'rest', request_type=domains.SearchDomainsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_domains(request) + + +def test_search_domains_rest_flattened(): + client = DomainsClient( + 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 = domains.SearchDomainsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_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 + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.search_domains(**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/{location=projects/*/locations/*}/registrations:searchDomains" % client.transport._host, args[1]) + + +def test_search_domains_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + + +def test_search_domains_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveRegisterParametersRequest, + dict, +]) +def test_retrieve_register_parameters_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.RetrieveRegisterParametersResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_register_parameters(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +def test_retrieve_register_parameters_rest_required_fields(request_type=domains.RetrieveRegisterParametersRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["domain_name"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "domainName" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == request_init["domain_name"] + + jsonified_request["domainName"] = 'domain_name_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("domain_name", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == 'domain_name_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.RetrieveRegisterParametersResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_register_parameters(request) + + expected_params = [ + ( + "domainName", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_register_parameters_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_register_parameters._get_unset_required_fields({}) + assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_register_parameters_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_register_parameters") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_register_parameters") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveRegisterParametersRequest.pb(domains.RetrieveRegisterParametersRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.RetrieveRegisterParametersResponse.to_json(domains.RetrieveRegisterParametersResponse()) + + request = domains.RetrieveRegisterParametersRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.RetrieveRegisterParametersResponse() + + client.retrieve_register_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_register_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveRegisterParametersRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_register_parameters(request) + + +def test_retrieve_register_parameters_rest_flattened(): + client = DomainsClient( + 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 = domains.RetrieveRegisterParametersResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_value', + domain_name='domain_name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_register_parameters(**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/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters" % client.transport._host, args[1]) + + +def test_retrieve_register_parameters_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +def test_retrieve_register_parameters_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RegisterDomainRequest, + dict, +]) +def test_register_domain_rest(request_type): + client = DomainsClient( + 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 = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_domain(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_register_domain_rest_required_fields(request_type=domains.RegisterDomainRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_domain._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()).register_domain._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_domain(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_domain_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_domain._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_domain_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_register_domain") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_register_domain") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RegisterDomainRequest.pb(domains.RegisterDomainRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.RegisterDomainRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.register_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_domain_rest_bad_request(transport: str = 'rest', request_type=domains.RegisterDomainRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_domain(request) + + +def test_register_domain_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_domain(**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/*}/registrations:register" % client.transport._host, args[1]) + + +def test_register_domain_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + + +def test_register_domain_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveTransferParametersRequest, + dict, +]) +def test_retrieve_transfer_parameters_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.RetrieveTransferParametersResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_transfer_parameters(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +def test_retrieve_transfer_parameters_rest_required_fields(request_type=domains.RetrieveTransferParametersRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["domain_name"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "domainName" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == request_init["domain_name"] + + jsonified_request["domainName"] = 'domain_name_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("domain_name", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == 'domain_name_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.RetrieveTransferParametersResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_transfer_parameters(request) + + expected_params = [ + ( + "domainName", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_transfer_parameters_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_transfer_parameters._get_unset_required_fields({}) + assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_transfer_parameters_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_transfer_parameters") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_transfer_parameters") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveTransferParametersRequest.pb(domains.RetrieveTransferParametersRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.RetrieveTransferParametersResponse.to_json(domains.RetrieveTransferParametersResponse()) + + request = domains.RetrieveTransferParametersRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.RetrieveTransferParametersResponse() + + client.retrieve_transfer_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_transfer_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveTransferParametersRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_transfer_parameters(request) + + +def test_retrieve_transfer_parameters_rest_flattened(): + client = DomainsClient( + 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 = domains.RetrieveTransferParametersResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_value', + domain_name='domain_name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_transfer_parameters(**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/{location=projects/*/locations/*}/registrations:retrieveTransferParameters" % client.transport._host, args[1]) + + +def test_retrieve_transfer_parameters_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +def test_retrieve_transfer_parameters_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.TransferDomainRequest, + dict, +]) +def test_transfer_domain_rest(request_type): + client = DomainsClient( + 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 = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.transfer_domain(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_transfer_domain_rest_required_fields(request_type=domains.TransferDomainRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).transfer_domain._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()).transfer_domain._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.transfer_domain(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_transfer_domain_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.transfer_domain._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_transfer_domain_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_transfer_domain") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_transfer_domain") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.TransferDomainRequest.pb(domains.TransferDomainRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.TransferDomainRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.transfer_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_transfer_domain_rest_bad_request(transport: str = 'rest', request_type=domains.TransferDomainRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.transfer_domain(request) + + +def test_transfer_domain_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.transfer_domain(**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/*}/registrations:transfer" % client.transport._host, args[1]) + + +def test_transfer_domain_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + + +def test_transfer_domain_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ListRegistrationsRequest, + dict, +]) +def test_list_registrations_rest(request_type): + client = DomainsClient( + 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 = domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_registrations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_registrations_rest_required_fields(request_type=domains.ListRegistrationsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_registrations._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_registrations._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("filter", "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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.ListRegistrationsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_registrations(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_registrations_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_registrations._get_unset_required_fields({}) + assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_registrations_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_list_registrations") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_list_registrations") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ListRegistrationsRequest.pb(domains.ListRegistrationsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.ListRegistrationsResponse.to_json(domains.ListRegistrationsResponse()) + + request = domains.ListRegistrationsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.ListRegistrationsResponse() + + client.list_registrations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_registrations_rest_bad_request(transport: str = 'rest', request_type=domains.ListRegistrationsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_registrations(request) + + +def test_list_registrations_rest_flattened(): + client = DomainsClient( + 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 = domains.ListRegistrationsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_registrations(**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/*}/registrations" % client.transport._host, args[1]) + + +def test_list_registrations_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + + +def test_list_registrations_rest_pager(transport: str = 'rest'): + client = DomainsClient( + 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 = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(domains.ListRegistrationsResponse.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_registrations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, domains.Registration) + for i in results) + + pages = list(client.list_registrations(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + domains.GetRegistrationRequest, + dict, +]) +def test_get_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/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 = domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_registration(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +def test_get_registration_rest_required_fields(request_type=domains.GetRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_registration._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_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.Registration() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_get_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_get_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.GetRegistrationRequest.pb(domains.GetRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.Registration.to_json(domains.Registration()) + + request = domains.GetRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.Registration() + + client.get_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_registration_rest_bad_request(transport: str = 'rest', request_type=domains.GetRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_registration(request) + + +def test_get_registration_rest_flattened(): + client = DomainsClient( + 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 = domains.Registration() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_registration(**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/*/registrations/*}" % client.transport._host, args[1]) + + +def test_get_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + + +def test_get_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.UpdateRegistrationRequest, + dict, +]) +def test_update_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_registration_rest_required_fields(request_type=domains.UpdateRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_update_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_update_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.UpdateRegistrationRequest.pb(domains.UpdateRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.UpdateRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_registration_rest_bad_request(transport: str = 'rest', request_type=domains.UpdateRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_registration(request) + + +def test_update_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_registration(**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/{registration.name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) + + +def test_update_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureManagementSettingsRequest, + dict, +]) +def test_configure_management_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_management_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_management_settings_rest_required_fields(request_type=domains.ConfigureManagementSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_management_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_management_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_management_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_management_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_management_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_management_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureManagementSettingsRequest.pb(domains.ConfigureManagementSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureManagementSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_management_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_management_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureManagementSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_management_settings(request) + + +def test_configure_management_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_management_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings" % client.transport._host, args[1]) + + +def test_configure_management_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_management_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureDnsSettingsRequest, + dict, +]) +def test_configure_dns_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_dns_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_dns_settings_rest_required_fields(request_type=domains.ConfigureDnsSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_dns_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_dns_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_dns_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_dns_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_dns_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_dns_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureDnsSettingsRequest.pb(domains.ConfigureDnsSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureDnsSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_dns_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_dns_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureDnsSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_dns_settings(request) + + +def test_configure_dns_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_dns_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings" % client.transport._host, args[1]) + + +def test_configure_dns_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_dns_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureContactSettingsRequest, + dict, +]) +def test_configure_contact_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_contact_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_contact_settings_rest_required_fields(request_type=domains.ConfigureContactSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_contact_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_contact_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_contact_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_contact_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_contact_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_contact_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureContactSettingsRequest.pb(domains.ConfigureContactSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureContactSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_contact_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_contact_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureContactSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_contact_settings(request) + + +def test_configure_contact_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_contact_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureContactSettings" % client.transport._host, args[1]) + + +def test_configure_contact_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_contact_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ExportRegistrationRequest, + dict, +]) +def test_export_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.export_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_export_registration_rest_required_fields(request_type=domains.ExportRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).export_registration._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()).export_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.export_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_export_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.export_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_export_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_export_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_export_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ExportRegistrationRequest.pb(domains.ExportRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ExportRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.export_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_export_registration_rest_bad_request(transport: str = 'rest', request_type=domains.ExportRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.export_registration(request) + + +def test_export_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.export_registration(**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/*/registrations/*}:export" % client.transport._host, args[1]) + + +def test_export_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + + +def test_export_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.DeleteRegistrationRequest, + dict, +]) +def test_delete_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_registration_rest_required_fields(request_type=domains.DeleteRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_registration._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_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_delete_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_delete_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.DeleteRegistrationRequest.pb(domains.DeleteRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.DeleteRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_registration_rest_bad_request(transport: str = 'rest', request_type=domains.DeleteRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_registration(request) + + +def test_delete_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_registration(**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/*/registrations/*}" % client.transport._host, args[1]) + + +def test_delete_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + + +def test_delete_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveAuthorizationCodeRequest, + dict, +]) +def test_retrieve_authorization_code_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( + code='code_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_authorization_code(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_retrieve_authorization_code_rest_required_fields(request_type=domains.RetrieveAuthorizationCodeRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.AuthorizationCode() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_authorization_code(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_authorization_code_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_authorization_code._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_authorization_code_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_authorization_code") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_authorization_code") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveAuthorizationCodeRequest.pb(domains.RetrieveAuthorizationCodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) + + request = domains.RetrieveAuthorizationCodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.AuthorizationCode() + + client.retrieve_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveAuthorizationCodeRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_authorization_code(request) + + +def test_retrieve_authorization_code_rest_flattened(): + client = DomainsClient( + 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 = domains.AuthorizationCode() + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_authorization_code(**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/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode" % client.transport._host, args[1]) + + +def test_retrieve_authorization_code_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + + +def test_retrieve_authorization_code_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ResetAuthorizationCodeRequest, + dict, +]) +def test_reset_authorization_code_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( + code='code_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.reset_authorization_code(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_reset_authorization_code_rest_required_fields(request_type=domains.ResetAuthorizationCodeRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.AuthorizationCode() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.reset_authorization_code(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_reset_authorization_code_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.reset_authorization_code._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_reset_authorization_code_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_reset_authorization_code") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_reset_authorization_code") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ResetAuthorizationCodeRequest.pb(domains.ResetAuthorizationCodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) + + request = domains.ResetAuthorizationCodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.AuthorizationCode() + + client.reset_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_reset_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.ResetAuthorizationCodeRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.reset_authorization_code(request) + + +def test_reset_authorization_code_rest_flattened(): + client = DomainsClient( + 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 = domains.AuthorizationCode() + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.reset_authorization_code(**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/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode" % client.transport._host, args[1]) + + +def test_reset_authorization_code_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + + +def test_reset_authorization_code_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = DomainsClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = DomainsClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = DomainsClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.DomainsGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + transports.DomainsRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = DomainsClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.DomainsGrpcTransport, + ) + +def test_domains_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.DomainsTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_domains_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.domains_v1.services.domains.transports.DomainsTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.DomainsTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'search_domains', + 'retrieve_register_parameters', + 'register_domain', + 'retrieve_transfer_parameters', + 'transfer_domain', + 'list_registrations', + 'get_registration', + 'update_registration', + 'configure_management_settings', + 'configure_dns_settings', + 'configure_contact_settings', + 'export_registration', + 'delete_registration', + 'retrieve_authorization_code', + 'reset_authorization_code', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_domains_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.domains_v1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.DomainsTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_domains_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.domains_v1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.DomainsTransport() + adc.assert_called_once() + + +def test_domains_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) + DomainsClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + ], +) +def test_domains_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + transports.DomainsRestTransport, + ], +) +def test_domains_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.DomainsGrpcTransport, grpc_helpers), + (transports.DomainsGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_domains_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( + "domains.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="domains.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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_domains_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.DomainsRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_domains_rest_lro_client(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_domains_host_no_port(transport_name): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://domains.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_domains_host_with_port(transport_name): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'domains.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://domains.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_domains_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = DomainsClient( + credentials=creds1, + transport=transport_name, + ) + client2 = DomainsClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.search_domains._session + session2 = client2.transport.search_domains._session + assert session1 != session2 + session1 = client1.transport.retrieve_register_parameters._session + session2 = client2.transport.retrieve_register_parameters._session + assert session1 != session2 + session1 = client1.transport.register_domain._session + session2 = client2.transport.register_domain._session + assert session1 != session2 + session1 = client1.transport.retrieve_transfer_parameters._session + session2 = client2.transport.retrieve_transfer_parameters._session + assert session1 != session2 + session1 = client1.transport.transfer_domain._session + session2 = client2.transport.transfer_domain._session + assert session1 != session2 + session1 = client1.transport.list_registrations._session + session2 = client2.transport.list_registrations._session + assert session1 != session2 + session1 = client1.transport.get_registration._session + session2 = client2.transport.get_registration._session + assert session1 != session2 + session1 = client1.transport.update_registration._session + session2 = client2.transport.update_registration._session + assert session1 != session2 + session1 = client1.transport.configure_management_settings._session + session2 = client2.transport.configure_management_settings._session + assert session1 != session2 + session1 = client1.transport.configure_dns_settings._session + session2 = client2.transport.configure_dns_settings._session + assert session1 != session2 + session1 = client1.transport.configure_contact_settings._session + session2 = client2.transport.configure_contact_settings._session + assert session1 != session2 + session1 = client1.transport.export_registration._session + session2 = client2.transport.export_registration._session + assert session1 != session2 + session1 = client1.transport.delete_registration._session + session2 = client2.transport.delete_registration._session + assert session1 != session2 + session1 = client1.transport.retrieve_authorization_code._session + session2 = client2.transport.retrieve_authorization_code._session + assert session1 != session2 + session1 = client1.transport.reset_authorization_code._session + session2 = client2.transport.reset_authorization_code._session + assert session1 != session2 +def test_domains_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.DomainsGrpcTransport( + 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_domains_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.DomainsGrpcAsyncIOTransport( + 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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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_domains_grpc_lro_client(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_domains_grpc_lro_async_client(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_registration_path(): + project = "squid" + location = "clam" + registration = "whelk" + expected = "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) + actual = DomainsClient.registration_path(project, location, registration) + assert expected == actual + + +def test_parse_registration_path(): + expected = { + "project": "octopus", + "location": "oyster", + "registration": "nudibranch", + } + path = DomainsClient.registration_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_registration_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = DomainsClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = DomainsClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = DomainsClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = DomainsClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = DomainsClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = DomainsClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = DomainsClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = DomainsClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.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 = DomainsClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = DomainsClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.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.DomainsTransport, '_prep_wrapped_messages') as prep: + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.DomainsTransport, '_prep_wrapped_messages') as prep: + transport_class = DomainsClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = DomainsClient( + 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", [ + (DomainsClient, transports.DomainsGrpcTransport), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v1beta1/.coveragerc b/owl-bot-staging/v1beta1/.coveragerc new file mode 100644 index 0000000..4cecf7e --- /dev/null +++ b/owl-bot-staging/v1beta1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/domains/__init__.py + google/cloud/domains/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/v1beta1/.flake8 b/owl-bot-staging/v1beta1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v1beta1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1beta1/MANIFEST.in b/owl-bot-staging/v1beta1/MANIFEST.in new file mode 100644 index 0000000..cc09b56 --- /dev/null +++ b/owl-bot-staging/v1beta1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/domains *.py +recursive-include google/cloud/domains_v1beta1 *.py diff --git a/owl-bot-staging/v1beta1/README.rst b/owl-bot-staging/v1beta1/README.rst new file mode 100644 index 0000000..6f21f3f --- /dev/null +++ b/owl-bot-staging/v1beta1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Domains 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 Domains API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1beta1/docs/conf.py b/owl-bot-staging/v1beta1/docs/conf.py new file mode 100644 index 0000000..2345777 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-domains documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-domains" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-domains-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-domains.tex", + u"google-cloud-domains 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-domains", + u"Google Cloud Domains 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-domains", + u"google-cloud-domains Documentation", + author, + "google-cloud-domains", + "GAPIC library for Google Cloud Domains API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst new file mode 100644 index 0000000..13d490a --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst @@ -0,0 +1,10 @@ +Domains +------------------------- + +.. automodule:: google.cloud.domains_v1beta1.services.domains + :members: + :inherited-members: + +.. automodule:: google.cloud.domains_v1beta1.services.domains.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst new file mode 100644 index 0000000..3e3faa8 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Domains v1beta1 API +============================================= +.. toctree:: + :maxdepth: 2 + + domains diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst new file mode 100644 index 0000000..dbbe2b8 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Domains v1beta1 API +========================================== + +.. automodule:: google.cloud.domains_v1beta1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1beta1/docs/index.rst b/owl-bot-staging/v1beta1/docs/index.rst new file mode 100644 index 0000000..0011907 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + domains_v1beta1/services + domains_v1beta1/types diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py new file mode 100644 index 0000000..0204ad4 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py @@ -0,0 +1,89 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.domains import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.domains_v1beta1.services.domains.client import DomainsClient +from google.cloud.domains_v1beta1.services.domains.async_client import DomainsAsyncClient + +from google.cloud.domains_v1beta1.types.domains import AuthorizationCode +from google.cloud.domains_v1beta1.types.domains import ConfigureContactSettingsRequest +from google.cloud.domains_v1beta1.types.domains import ConfigureDnsSettingsRequest +from google.cloud.domains_v1beta1.types.domains import ConfigureManagementSettingsRequest +from google.cloud.domains_v1beta1.types.domains import ContactSettings +from google.cloud.domains_v1beta1.types.domains import DeleteRegistrationRequest +from google.cloud.domains_v1beta1.types.domains import DnsSettings +from google.cloud.domains_v1beta1.types.domains import ExportRegistrationRequest +from google.cloud.domains_v1beta1.types.domains import GetRegistrationRequest +from google.cloud.domains_v1beta1.types.domains import ListRegistrationsRequest +from google.cloud.domains_v1beta1.types.domains import ListRegistrationsResponse +from google.cloud.domains_v1beta1.types.domains import ManagementSettings +from google.cloud.domains_v1beta1.types.domains import OperationMetadata +from google.cloud.domains_v1beta1.types.domains import RegisterDomainRequest +from google.cloud.domains_v1beta1.types.domains import RegisterParameters +from google.cloud.domains_v1beta1.types.domains import Registration +from google.cloud.domains_v1beta1.types.domains import ResetAuthorizationCodeRequest +from google.cloud.domains_v1beta1.types.domains import RetrieveAuthorizationCodeRequest +from google.cloud.domains_v1beta1.types.domains import RetrieveRegisterParametersRequest +from google.cloud.domains_v1beta1.types.domains import RetrieveRegisterParametersResponse +from google.cloud.domains_v1beta1.types.domains import RetrieveTransferParametersRequest +from google.cloud.domains_v1beta1.types.domains import RetrieveTransferParametersResponse +from google.cloud.domains_v1beta1.types.domains import SearchDomainsRequest +from google.cloud.domains_v1beta1.types.domains import SearchDomainsResponse +from google.cloud.domains_v1beta1.types.domains import TransferDomainRequest +from google.cloud.domains_v1beta1.types.domains import TransferParameters +from google.cloud.domains_v1beta1.types.domains import UpdateRegistrationRequest +from google.cloud.domains_v1beta1.types.domains import ContactNotice +from google.cloud.domains_v1beta1.types.domains import ContactPrivacy +from google.cloud.domains_v1beta1.types.domains import DomainNotice +from google.cloud.domains_v1beta1.types.domains import TransferLockState + +__all__ = ('DomainsClient', + 'DomainsAsyncClient', + 'AuthorizationCode', + 'ConfigureContactSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureManagementSettingsRequest', + 'ContactSettings', + 'DeleteRegistrationRequest', + 'DnsSettings', + 'ExportRegistrationRequest', + 'GetRegistrationRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'ManagementSettings', + 'OperationMetadata', + 'RegisterDomainRequest', + 'RegisterParameters', + 'Registration', + 'ResetAuthorizationCodeRequest', + 'RetrieveAuthorizationCodeRequest', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'TransferDomainRequest', + 'TransferParameters', + 'UpdateRegistrationRequest', + 'ContactNotice', + 'ContactPrivacy', + 'DomainNotice', + 'TransferLockState', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/py.typed b/owl-bot-staging/v1beta1/google/cloud/domains/py.typed new file mode 100644 index 0000000..b463d6c --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py new file mode 100644 index 0000000..f0fc498 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.domains_v1beta1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.domains import DomainsClient +from .services.domains import DomainsAsyncClient + +from .types.domains import AuthorizationCode +from .types.domains import ConfigureContactSettingsRequest +from .types.domains import ConfigureDnsSettingsRequest +from .types.domains import ConfigureManagementSettingsRequest +from .types.domains import ContactSettings +from .types.domains import DeleteRegistrationRequest +from .types.domains import DnsSettings +from .types.domains import ExportRegistrationRequest +from .types.domains import GetRegistrationRequest +from .types.domains import ListRegistrationsRequest +from .types.domains import ListRegistrationsResponse +from .types.domains import ManagementSettings +from .types.domains import OperationMetadata +from .types.domains import RegisterDomainRequest +from .types.domains import RegisterParameters +from .types.domains import Registration +from .types.domains import ResetAuthorizationCodeRequest +from .types.domains import RetrieveAuthorizationCodeRequest +from .types.domains import RetrieveRegisterParametersRequest +from .types.domains import RetrieveRegisterParametersResponse +from .types.domains import RetrieveTransferParametersRequest +from .types.domains import RetrieveTransferParametersResponse +from .types.domains import SearchDomainsRequest +from .types.domains import SearchDomainsResponse +from .types.domains import TransferDomainRequest +from .types.domains import TransferParameters +from .types.domains import UpdateRegistrationRequest +from .types.domains import ContactNotice +from .types.domains import ContactPrivacy +from .types.domains import DomainNotice +from .types.domains import TransferLockState + +__all__ = ( + 'DomainsAsyncClient', +'AuthorizationCode', +'ConfigureContactSettingsRequest', +'ConfigureDnsSettingsRequest', +'ConfigureManagementSettingsRequest', +'ContactNotice', +'ContactPrivacy', +'ContactSettings', +'DeleteRegistrationRequest', +'DnsSettings', +'DomainNotice', +'DomainsClient', +'ExportRegistrationRequest', +'GetRegistrationRequest', +'ListRegistrationsRequest', +'ListRegistrationsResponse', +'ManagementSettings', +'OperationMetadata', +'RegisterDomainRequest', +'RegisterParameters', +'Registration', +'ResetAuthorizationCodeRequest', +'RetrieveAuthorizationCodeRequest', +'RetrieveRegisterParametersRequest', +'RetrieveRegisterParametersResponse', +'RetrieveTransferParametersRequest', +'RetrieveTransferParametersResponse', +'SearchDomainsRequest', +'SearchDomainsResponse', +'TransferDomainRequest', +'TransferLockState', +'TransferParameters', +'UpdateRegistrationRequest', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json new file mode 100644 index 0000000..fa29a8d --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json @@ -0,0 +1,253 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.domains_v1beta1", + "protoPackage": "google.cloud.domains.v1beta1", + "schema": "1.0", + "services": { + "Domains": { + "clients": { + "grpc": { + "libraryClient": "DomainsClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + }, + "grpc-async": { + "libraryClient": "DomainsAsyncClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + }, + "rest": { + "libraryClient": "DomainsClient", + "rpcs": { + "ConfigureContactSettings": { + "methods": [ + "configure_contact_settings" + ] + }, + "ConfigureDnsSettings": { + "methods": [ + "configure_dns_settings" + ] + }, + "ConfigureManagementSettings": { + "methods": [ + "configure_management_settings" + ] + }, + "DeleteRegistration": { + "methods": [ + "delete_registration" + ] + }, + "ExportRegistration": { + "methods": [ + "export_registration" + ] + }, + "GetRegistration": { + "methods": [ + "get_registration" + ] + }, + "ListRegistrations": { + "methods": [ + "list_registrations" + ] + }, + "RegisterDomain": { + "methods": [ + "register_domain" + ] + }, + "ResetAuthorizationCode": { + "methods": [ + "reset_authorization_code" + ] + }, + "RetrieveAuthorizationCode": { + "methods": [ + "retrieve_authorization_code" + ] + }, + "RetrieveRegisterParameters": { + "methods": [ + "retrieve_register_parameters" + ] + }, + "RetrieveTransferParameters": { + "methods": [ + "retrieve_transfer_parameters" + ] + }, + "SearchDomains": { + "methods": [ + "search_domains" + ] + }, + "TransferDomain": { + "methods": [ + "transfer_domain" + ] + }, + "UpdateRegistration": { + "methods": [ + "update_registration" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed new file mode 100644 index 0000000..b463d6c --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py new file mode 100644 index 0000000..28d2584 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import DomainsClient +from .async_client import DomainsAsyncClient + +__all__ = ( + 'DomainsClient', + 'DomainsAsyncClient', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py new file mode 100644 index 0000000..8e5e81f --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py @@ -0,0 +1,2284 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.domains_v1beta1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.domains_v1beta1.services.domains import pagers +from google.cloud.domains_v1beta1.types import domains +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport +from .client import DomainsClient + + +class DomainsAsyncClient: + """The Cloud Domains API enables management and configuration of + domain names. + """ + + _client: DomainsClient + + DEFAULT_ENDPOINT = DomainsClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = DomainsClient.DEFAULT_MTLS_ENDPOINT + + registration_path = staticmethod(DomainsClient.registration_path) + parse_registration_path = staticmethod(DomainsClient.parse_registration_path) + common_billing_account_path = staticmethod(DomainsClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(DomainsClient.parse_common_billing_account_path) + common_folder_path = staticmethod(DomainsClient.common_folder_path) + parse_common_folder_path = staticmethod(DomainsClient.parse_common_folder_path) + common_organization_path = staticmethod(DomainsClient.common_organization_path) + parse_common_organization_path = staticmethod(DomainsClient.parse_common_organization_path) + common_project_path = staticmethod(DomainsClient.common_project_path) + parse_common_project_path = staticmethod(DomainsClient.parse_common_project_path) + common_location_path = staticmethod(DomainsClient.common_location_path) + parse_common_location_path = staticmethod(DomainsClient.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: + DomainsAsyncClient: The constructed client. + """ + return DomainsClient.from_service_account_info.__func__(DomainsAsyncClient, 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: + DomainsAsyncClient: The constructed client. + """ + return DomainsClient.from_service_account_file.__func__(DomainsAsyncClient, 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 DomainsClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> DomainsTransport: + """Returns the transport used by the client instance. + + Returns: + DomainsTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(DomainsClient).get_transport_class, type(DomainsClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, DomainsTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the domains client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.DomainsTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = DomainsClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def search_domains(self, + request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, + *, + location: 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, str]] = (), + ) -> domains.SearchDomainsResponse: + r"""Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + .. 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 domains_v1beta1 + + async def sample_search_domains(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = await client.search_domains(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]]): + The request object. Request for the ``SearchDomains`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Required. String used to search for + available domain names. + + 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, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.SearchDomainsResponse: + Response for the SearchDomains method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, query]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.SearchDomainsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_domains, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def retrieve_register_parameters(self, + request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + .. 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 domains_v1beta1 + + async def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]]): + The request object. Request for the ``RetrieveRegisterParameters`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (:class:`str`): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse: + Response for the RetrieveRegisterParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveRegisterParametersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_register_parameters, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def register_domain(self, + request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + .. 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 domains_v1beta1 + + async def sample_register_domain(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]]): + The request object. Request for the ``RegisterDomain`` method. + parent (:class:`str`): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (:class:`google.cloud.domains_v1beta1.types.Registration`): + Required. The complete ``Registration`` resource to be + created. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (:class:`google.type.money_pb2.Money`): + Required. Yearly price to register or + renew the domain. The value that should + be put here can be obtained from + RetrieveRegisterParameters or + SearchDomains calls. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RegisterDomainRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.register_domain, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def retrieve_transfer_parameters(self, + request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveTransferParametersResponse: + r"""Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + .. 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 domains_v1beta1 + + async def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]]): + The request object. Request for the ``RetrieveTransferParameters`` method. + location (:class:`str`): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (:class:`str`): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse: + Response for the RetrieveTransferParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveTransferParametersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_transfer_parameters, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def transfer_domain(self, + request: Optional[Union[domains.TransferDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + authorization_code: Optional[domains.AuthorizationCode] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + .. 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 domains_v1beta1 + + async def sample_transfer_domain(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]]): + The request object. Request for the ``TransferDomain`` method. + parent (:class:`str`): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (:class:`google.cloud.domains_v1beta1.types.Registration`): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to + import the domain's current DNS configuration from its + current registrar. Use this option only if you are sure + that the domain's current DNS service does not cease + upon transfer, as is often the case for DNS services + provided for free by the registrar. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (:class:`google.type.money_pb2.Money`): + Required. Acknowledgement of the price to transfer or + renew the domain for one year. Call + ``RetrieveTransferParameters`` to obtain the price, + which you must acknowledge. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + authorization_code (:class:`google.cloud.domains_v1beta1.types.AuthorizationCode`): + The domain's transfer authorization + code. You can obtain this from the + domain's current registrar. + + This corresponds to the ``authorization_code`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price, authorization_code]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.TransferDomainRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + if authorization_code is not None: + request.authorization_code = authorization_code + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.transfer_domain, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_registrations(self, + request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRegistrationsAsyncPager: + r"""Lists the ``Registration`` resources in a 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 domains_v1beta1 + + async def sample_list_registrations(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]]): + The request object. Request for the ``ListRegistrations`` method. + parent (:class:`str`): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager: + Response for the ListRegistrations method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ListRegistrationsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_registrations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRegistrationsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_registration(self, + request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.Registration: + r"""Gets the details of a ``Registration`` 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 domains_v1beta1 + + async def sample_get_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_registration(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]]): + The request object. Request for the ``GetRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to get, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.Registration: + The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.GetRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_registration(self, + request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, + *, + registration: Optional[domains.Registration] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + .. 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 domains_v1beta1 + + async def sample_update_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]]): + The request object. Request for the ``UpdateRegistration`` method. + registration (:class:`google.cloud.domains_v1beta1.types.Registration`): + Fields of the ``Registration`` to update. + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the labels are being updated, the ``update_mask`` is + ``"labels"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.UpdateRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration.name", request.registration.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_management_settings(self, + request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + management_settings: Optional[domains.ManagementSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s management settings. + + .. 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 domains_v1beta1 + + async def sample_configure_management_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]]): + The request object. Request for the ``ConfigureManagementSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + management settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + management_settings (:class:`google.cloud.domains_v1beta1.types.ManagementSettings`): + Fields of the ``ManagementSettings`` to update. + This corresponds to the ``management_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the transfer lock is being updated, the ``update_mask`` + is ``"transfer_lock_state"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, management_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureManagementSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if management_settings is not None: + request.management_settings = management_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_management_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_dns_settings(self, + request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + dns_settings: Optional[domains.DnsSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s DNS settings. + + .. 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 domains_v1beta1 + + async def sample_configure_dns_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]]): + The request object. Request for the ``ConfigureDnsSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + dns_settings (:class:`google.cloud.domains_v1beta1.types.DnsSettings`): + Fields of the ``DnsSettings`` to update. + This corresponds to the ``dns_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the name servers are being updated for an existing + Custom DNS configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains + DNS configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, dns_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureDnsSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if dns_settings is not None: + request.dns_settings = dns_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_dns_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def configure_contact_settings(self, + request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + contact_settings: Optional[domains.ContactSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + .. 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 domains_v1beta1 + + async def sample_configure_contact_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]]): + The request object. Request for the ``ConfigureContactSettings`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact_settings (:class:`google.cloud.domains_v1beta1.types.ContactSettings`): + Fields of the ``ContactSettings`` to update. + This corresponds to the ``contact_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the registrant contact is being updated, the + ``update_mask`` is ``"registrant_contact"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, contact_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ConfigureContactSettingsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if contact_settings is not None: + request.contact_settings = contact_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.configure_contact_settings, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def export_registration(self, + request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1beta1 + + async def sample_export_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]]): + The request object. Request for the ``ExportRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to export, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ExportRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.export_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_registration(self, + request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1beta1 + + async def sample_delete_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]]): + The request object. Request for the ``DeleteRegistration`` method. + name (:class:`str`): + Required. The name of the ``Registration`` to delete, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.DeleteRegistrationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_registration, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + async def retrieve_authorization_code(self, + request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1beta1 + + async def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]]): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.RetrieveAuthorizationCodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_authorization_code, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def reset_authorization_code(self, + request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1beta1 + + async def sample_reset_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.reset_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]]): + The request object. Request for the ``ResetAuthorizationCode`` method. + registration (:class:`str`): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = domains.ResetAuthorizationCodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.reset_authorization_code, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "DomainsAsyncClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py new file mode 100644 index 0000000..230404f --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py @@ -0,0 +1,2488 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.domains_v1beta1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.domains_v1beta1.services.domains import pagers +from google.cloud.domains_v1beta1.types import domains +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import DomainsGrpcTransport +from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport +from .transports.rest import DomainsRestTransport + + +class DomainsClientMeta(type): + """Metaclass for the Domains 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[DomainsTransport]] + _transport_registry["grpc"] = DomainsGrpcTransport + _transport_registry["grpc_asyncio"] = DomainsGrpcAsyncIOTransport + _transport_registry["rest"] = DomainsRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[DomainsTransport]: + """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 DomainsClient(metaclass=DomainsClientMeta): + """The Cloud Domains API enables management and configuration of + domain names. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "domains.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + DomainsClient: 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: + DomainsClient: 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) -> DomainsTransport: + """Returns the transport used by the client instance. + + Returns: + DomainsTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def registration_path(project: str,location: str,registration: str,) -> str: + """Returns a fully-qualified registration string.""" + return "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) + + @staticmethod + def parse_registration_path(path: str) -> Dict[str,str]: + """Parses a registration path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/registrations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, DomainsTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the domains client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, DomainsTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, DomainsTransport): + # transport is a DomainsTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def search_domains(self, + request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, + *, + location: 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, str]] = (), + ) -> domains.SearchDomainsResponse: + r"""Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + .. 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 domains_v1beta1 + + def sample_search_domains(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = client.search_domains(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]): + The request object. Request for the ``SearchDomains`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Required. String used to search for + available domain names. + + 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, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.SearchDomainsResponse: + Response for the SearchDomains method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, query]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.SearchDomainsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.SearchDomainsRequest): + request = domains.SearchDomainsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + 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_domains] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def retrieve_register_parameters(self, + request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + .. 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 domains_v1beta1 + + def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]): + The request object. Request for the ``RetrieveRegisterParameters`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (str): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse: + Response for the RetrieveRegisterParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveRegisterParametersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveRegisterParametersRequest): + request = domains.RetrieveRegisterParametersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_register_parameters] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def register_domain(self, + request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + .. 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 domains_v1beta1 + + def sample_register_domain(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]): + The request object. Request for the ``RegisterDomain`` method. + parent (str): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (google.cloud.domains_v1beta1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (google.type.money_pb2.Money): + Required. Yearly price to register or + renew the domain. The value that should + be put here can be obtained from + RetrieveRegisterParameters or + SearchDomains calls. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RegisterDomainRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RegisterDomainRequest): + request = domains.RegisterDomainRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.register_domain] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def retrieve_transfer_parameters(self, + request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, + *, + location: Optional[str] = None, + domain_name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.RetrieveTransferParametersResponse: + r"""Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + .. 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 domains_v1beta1 + + def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]): + The request object. Request for the ``RetrieveTransferParameters`` method. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + + This corresponds to the ``location`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + domain_name (str): + Required. The domain name. Unicode + domain names must be expressed in + Punycode format. + + This corresponds to the ``domain_name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse: + Response for the RetrieveTransferParameters method. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([location, domain_name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveTransferParametersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveTransferParametersRequest): + request = domains.RetrieveTransferParametersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if location is not None: + request.location = location + if domain_name is not None: + request.domain_name = domain_name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_transfer_parameters] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("location", request.location), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def transfer_domain(self, + request: Optional[Union[domains.TransferDomainRequest, dict]] = None, + *, + parent: Optional[str] = None, + registration: Optional[domains.Registration] = None, + yearly_price: Optional[money_pb2.Money] = None, + authorization_code: Optional[domains.AuthorizationCode] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + .. 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 domains_v1beta1 + + def sample_transfer_domain(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]): + The request object. Request for the ``TransferDomain`` method. + parent (str): + Required. The parent resource of the ``Registration``. + Must be in the format ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + registration (google.cloud.domains_v1beta1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to + import the domain's current DNS configuration from its + current registrar. Use this option only if you are sure + that the domain's current DNS service does not cease + upon transfer, as is often the case for DNS services + provided for free by the registrar. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + yearly_price (google.type.money_pb2.Money): + Required. Acknowledgement of the price to transfer or + renew the domain for one year. Call + ``RetrieveTransferParameters`` to obtain the price, + which you must acknowledge. + + This corresponds to the ``yearly_price`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + authorization_code (google.cloud.domains_v1beta1.types.AuthorizationCode): + The domain's transfer authorization + code. You can obtain this from the + domain's current registrar. + + This corresponds to the ``authorization_code`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, registration, yearly_price, authorization_code]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.TransferDomainRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.TransferDomainRequest): + request = domains.TransferDomainRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if registration is not None: + request.registration = registration + if yearly_price is not None: + request.yearly_price = yearly_price + if authorization_code is not None: + request.authorization_code = authorization_code + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.transfer_domain] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_registrations(self, + request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRegistrationsPager: + r"""Lists the ``Registration`` resources in a 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 domains_v1beta1 + + def sample_list_registrations(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]): + The request object. Request for the ``ListRegistrations`` method. + parent (str): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager: + Response for the ListRegistrations method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ListRegistrationsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ListRegistrationsRequest): + request = domains.ListRegistrationsRequest(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_registrations] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRegistrationsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_registration(self, + request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.Registration: + r"""Gets the details of a ``Registration`` 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 domains_v1beta1 + + def sample_get_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = client.get_registration(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]): + The request object. Request for the ``GetRegistration`` method. + name (str): + Required. The name of the ``Registration`` to get, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.Registration: + The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.GetRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.GetRegistrationRequest): + request = domains.GetRegistrationRequest(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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_registration(self, + request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, + *, + registration: Optional[domains.Registration] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + .. 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 domains_v1beta1 + + def sample_update_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]): + The request object. Request for the ``UpdateRegistration`` method. + registration (google.cloud.domains_v1beta1.types.Registration): + Fields of the ``Registration`` to update. + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the labels are being updated, the ``update_mask`` is + ``"labels"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.UpdateRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.UpdateRegistrationRequest): + request = domains.UpdateRegistrationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + 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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration.name", request.registration.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_management_settings(self, + request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + management_settings: Optional[domains.ManagementSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s management settings. + + .. 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 domains_v1beta1 + + def sample_configure_management_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]): + The request object. Request for the ``ConfigureManagementSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose + management settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): + Fields of the ``ManagementSettings`` to update. + This corresponds to the ``management_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the transfer lock is being updated, the ``update_mask`` + is ``"transfer_lock_state"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, management_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureManagementSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureManagementSettingsRequest): + request = domains.ConfigureManagementSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if management_settings is not None: + request.management_settings = management_settings + 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.configure_management_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_dns_settings(self, + request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + dns_settings: Optional[domains.DnsSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s DNS settings. + + .. 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 domains_v1beta1 + + def sample_configure_dns_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]): + The request object. Request for the ``ConfigureDnsSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): + Fields of the ``DnsSettings`` to update. + This corresponds to the ``dns_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the name servers are being updated for an existing + Custom DNS configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains + DNS configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, dns_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureDnsSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureDnsSettingsRequest): + request = domains.ConfigureDnsSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if dns_settings is not None: + request.dns_settings = dns_settings + 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.configure_dns_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def configure_contact_settings(self, + request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, + *, + registration: Optional[str] = None, + contact_settings: Optional[domains.ContactSettings] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + .. 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 domains_v1beta1 + + def sample_configure_contact_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]): + The request object. Request for the ``ConfigureContactSettings`` method. + registration (str): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): + Fields of the ``ContactSettings`` to update. + This corresponds to the ``contact_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to + update as a comma-separated list. For example, if only + the registrant contact is being updated, the + ``update_mask`` is ``"registrant_contact"``. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration, contact_settings, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ConfigureContactSettingsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ConfigureContactSettingsRequest): + request = domains.ConfigureContactSettingsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + if contact_settings is not None: + request.contact_settings = contact_settings + 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.configure_contact_settings] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def export_registration(self, + request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1beta1 + + def sample_export_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]): + The request object. Request for the ``ExportRegistration`` method. + name (str): + Required. The name of the ``Registration`` to export, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name + registrations. + + There are several ways to create a new Registration + resource: + + To create a new Registration resource, find a + suitable domain name by calling the SearchDomains + method with a query to see available domain name + options. After choosing a name, call + RetrieveRegisterParameters to ensure availability and + obtain information like pricing, which is needed to + build a call to RegisterDomain. + + Another way to create a new Registration is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the + domain for transfer and retrieve the domain's + transfer authorization code. Then call + RetrieveTransferParameters to confirm that the domain + is unlocked and to get values needed to build a call + to TransferDomain. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ExportRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ExportRegistrationRequest): + request = domains.ExportRegistrationRequest(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.export_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + domains.Registration, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_registration(self, + request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + .. 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 domains_v1beta1 + + def sample_delete_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]): + The request object. Request for the ``DeleteRegistration`` method. + name (str): + Required. The name of the ``Registration`` to delete, in + the format ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.DeleteRegistrationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.DeleteRegistrationRequest): + request = domains.DeleteRegistrationRequest(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_registration] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=domains.OperationMetadata, + ) + + # Done; return the response. + return response + + def retrieve_authorization_code(self, + request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1beta1 + + def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.RetrieveAuthorizationCodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.RetrieveAuthorizationCodeRequest): + request = domains.RetrieveAuthorizationCodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_authorization_code] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def reset_authorization_code(self, + request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, + *, + registration: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> domains.AuthorizationCode: + r"""Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + .. 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 domains_v1beta1 + + def sample_reset_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.reset_authorization_code(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]): + The request object. Request for the ``ResetAuthorizationCode`` method. + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + + This corresponds to the ``registration`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.domains_v1beta1.types.AuthorizationCode: + Defines an authorization code. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([registration]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a domains.ResetAuthorizationCodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, domains.ResetAuthorizationCodeRequest): + request = domains.ResetAuthorizationCodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if registration is not None: + request.registration = registration + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.reset_authorization_code] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("registration", request.registration), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "DomainsClient": + 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__) + + +__all__ = ( + "DomainsClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py new file mode 100644 index 0000000..32e20ac --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py @@ -0,0 +1,139 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.domains_v1beta1.types import domains + + +class ListRegistrationsPager: + """A pager for iterating through ``list_registrations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``registrations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRegistrations`` requests and continue to iterate + through the ``registrations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` + 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[..., domains.ListRegistrationsResponse], + request: domains.ListRegistrationsRequest, + response: domains.ListRegistrationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.domains_v1beta1.types.ListRegistrationsRequest): + The initial request object. + response (google.cloud.domains_v1beta1.types.ListRegistrationsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = domains.ListRegistrationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[domains.ListRegistrationsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[domains.Registration]: + for page in self.pages: + yield from page.registrations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRegistrationsAsyncPager: + """A pager for iterating through ``list_registrations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``registrations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRegistrations`` requests and continue to iterate + through the ``registrations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` + 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[domains.ListRegistrationsResponse]], + request: domains.ListRegistrationsRequest, + response: domains.ListRegistrationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.domains_v1beta1.types.ListRegistrationsRequest): + The initial request object. + response (google.cloud.domains_v1beta1.types.ListRegistrationsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = domains.ListRegistrationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[domains.ListRegistrationsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[domains.Registration]: + async def async_generator(): + async for page in self.pages: + for response in page.registrations: + 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/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py new file mode 100644 index 0000000..8648a03 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import DomainsTransport +from .grpc import DomainsGrpcTransport +from .grpc_asyncio import DomainsGrpcAsyncIOTransport +from .rest import DomainsRestTransport +from .rest import DomainsRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[DomainsTransport]] +_transport_registry['grpc'] = DomainsGrpcTransport +_transport_registry['grpc_asyncio'] = DomainsGrpcAsyncIOTransport +_transport_registry['rest'] = DomainsRestTransport + +__all__ = ( + 'DomainsTransport', + 'DomainsGrpcTransport', + 'DomainsGrpcAsyncIOTransport', + 'DomainsRestTransport', + 'DomainsRestInterceptor', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py new file mode 100644 index 0000000..3d2265d --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py @@ -0,0 +1,351 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.domains_v1beta1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.domains_v1beta1.types import domains +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class DomainsTransport(abc.ABC): + """Abstract transport class for Domains.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'domains.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.search_domains: gapic_v1.method.wrap_method( + self.search_domains, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_register_parameters: gapic_v1.method.wrap_method( + self.retrieve_register_parameters, + default_timeout=None, + client_info=client_info, + ), + self.register_domain: gapic_v1.method.wrap_method( + self.register_domain, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_transfer_parameters: gapic_v1.method.wrap_method( + self.retrieve_transfer_parameters, + default_timeout=None, + client_info=client_info, + ), + self.transfer_domain: gapic_v1.method.wrap_method( + self.transfer_domain, + default_timeout=None, + client_info=client_info, + ), + self.list_registrations: gapic_v1.method.wrap_method( + self.list_registrations, + default_timeout=None, + client_info=client_info, + ), + self.get_registration: gapic_v1.method.wrap_method( + self.get_registration, + default_timeout=None, + client_info=client_info, + ), + self.update_registration: gapic_v1.method.wrap_method( + self.update_registration, + default_timeout=None, + client_info=client_info, + ), + self.configure_management_settings: gapic_v1.method.wrap_method( + self.configure_management_settings, + default_timeout=None, + client_info=client_info, + ), + self.configure_dns_settings: gapic_v1.method.wrap_method( + self.configure_dns_settings, + default_timeout=None, + client_info=client_info, + ), + self.configure_contact_settings: gapic_v1.method.wrap_method( + self.configure_contact_settings, + default_timeout=None, + client_info=client_info, + ), + self.export_registration: gapic_v1.method.wrap_method( + self.export_registration, + default_timeout=None, + client_info=client_info, + ), + self.delete_registration: gapic_v1.method.wrap_method( + self.delete_registration, + default_timeout=None, + client_info=client_info, + ), + self.retrieve_authorization_code: gapic_v1.method.wrap_method( + self.retrieve_authorization_code, + default_timeout=None, + client_info=client_info, + ), + self.reset_authorization_code: gapic_v1.method.wrap_method( + self.reset_authorization_code, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + Union[ + domains.SearchDomainsResponse, + Awaitable[domains.SearchDomainsResponse] + ]]: + raise NotImplementedError() + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + Union[ + domains.RetrieveRegisterParametersResponse, + Awaitable[domains.RetrieveRegisterParametersResponse] + ]]: + raise NotImplementedError() + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + Union[ + domains.RetrieveTransferParametersResponse, + Awaitable[domains.RetrieveTransferParametersResponse] + ]]: + raise NotImplementedError() + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + Union[ + domains.ListRegistrationsResponse, + Awaitable[domains.ListRegistrationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + Union[ + domains.Registration, + Awaitable[domains.Registration] + ]]: + raise NotImplementedError() + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + Union[ + domains.AuthorizationCode, + Awaitable[domains.AuthorizationCode] + ]]: + raise NotImplementedError() + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + Union[ + domains.AuthorizationCode, + Awaitable[domains.AuthorizationCode] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'DomainsTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py new file mode 100644 index 0000000..e722cf5 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py @@ -0,0 +1,742 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.domains_v1beta1.types import domains +from google.longrunning import operations_pb2 # type: ignore +from .base import DomainsTransport, DEFAULT_CLIENT_INFO + + +class DomainsGrpcTransport(DomainsTransport): + """gRPC backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + domains.SearchDomainsResponse]: + r"""Return a callable for the search domains method over gRPC. + + Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + Returns: + Callable[[~.SearchDomainsRequest], + ~.SearchDomainsResponse]: + 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_domains' not in self._stubs: + self._stubs['search_domains'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/SearchDomains', + request_serializer=domains.SearchDomainsRequest.serialize, + response_deserializer=domains.SearchDomainsResponse.deserialize, + ) + return self._stubs['search_domains'] + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + domains.RetrieveRegisterParametersResponse]: + r"""Return a callable for the retrieve register parameters method over gRPC. + + Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + Returns: + Callable[[~.RetrieveRegisterParametersRequest], + ~.RetrieveRegisterParametersResponse]: + 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 'retrieve_register_parameters' not in self._stubs: + self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveRegisterParameters', + request_serializer=domains.RetrieveRegisterParametersRequest.serialize, + response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, + ) + return self._stubs['retrieve_register_parameters'] + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + operations_pb2.Operation]: + r"""Return a callable for the register domain method over gRPC. + + Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + Returns: + Callable[[~.RegisterDomainRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_domain' not in self._stubs: + self._stubs['register_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RegisterDomain', + request_serializer=domains.RegisterDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['register_domain'] + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + domains.RetrieveTransferParametersResponse]: + r"""Return a callable for the retrieve transfer parameters method over gRPC. + + Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + Returns: + Callable[[~.RetrieveTransferParametersRequest], + ~.RetrieveTransferParametersResponse]: + 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 'retrieve_transfer_parameters' not in self._stubs: + self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveTransferParameters', + request_serializer=domains.RetrieveTransferParametersRequest.serialize, + response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, + ) + return self._stubs['retrieve_transfer_parameters'] + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + operations_pb2.Operation]: + r"""Return a callable for the transfer domain method over gRPC. + + Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + Returns: + Callable[[~.TransferDomainRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'transfer_domain' not in self._stubs: + self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/TransferDomain', + request_serializer=domains.TransferDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['transfer_domain'] + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + domains.ListRegistrationsResponse]: + r"""Return a callable for the list registrations method over gRPC. + + Lists the ``Registration`` resources in a project. + + Returns: + Callable[[~.ListRegistrationsRequest], + ~.ListRegistrationsResponse]: + 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_registrations' not in self._stubs: + self._stubs['list_registrations'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ListRegistrations', + request_serializer=domains.ListRegistrationsRequest.serialize, + response_deserializer=domains.ListRegistrationsResponse.deserialize, + ) + return self._stubs['list_registrations'] + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + domains.Registration]: + r"""Return a callable for the get registration method over gRPC. + + Gets the details of a ``Registration`` resource. + + Returns: + Callable[[~.GetRegistrationRequest], + ~.Registration]: + 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_registration' not in self._stubs: + self._stubs['get_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/GetRegistration', + request_serializer=domains.GetRegistrationRequest.serialize, + response_deserializer=domains.Registration.deserialize, + ) + return self._stubs['get_registration'] + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the update registration method over gRPC. + + Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + Returns: + Callable[[~.UpdateRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_registration' not in self._stubs: + self._stubs['update_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/UpdateRegistration', + request_serializer=domains.UpdateRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_registration'] + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure management settings method over gRPC. + + Updates a ``Registration``'s management settings. + + Returns: + Callable[[~.ConfigureManagementSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_management_settings' not in self._stubs: + self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureManagementSettings', + request_serializer=domains.ConfigureManagementSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_management_settings'] + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure dns settings method over gRPC. + + Updates a ``Registration``'s DNS settings. + + Returns: + Callable[[~.ConfigureDnsSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_dns_settings' not in self._stubs: + self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureDnsSettings', + request_serializer=domains.ConfigureDnsSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_dns_settings'] + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + operations_pb2.Operation]: + r"""Return a callable for the configure contact settings method over gRPC. + + Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + Returns: + Callable[[~.ConfigureContactSettingsRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_contact_settings' not in self._stubs: + self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureContactSettings', + request_serializer=domains.ConfigureContactSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_contact_settings'] + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the export registration method over gRPC. + + Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.ExportRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'export_registration' not in self._stubs: + self._stubs['export_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ExportRegistration', + request_serializer=domains.ExportRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['export_registration'] + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete registration method over gRPC. + + Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.DeleteRegistrationRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_registration' not in self._stubs: + self._stubs['delete_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/DeleteRegistration', + request_serializer=domains.DeleteRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_registration'] + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + domains.AuthorizationCode]: + r"""Return a callable for the retrieve authorization code method over gRPC. + + Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.RetrieveAuthorizationCodeRequest], + ~.AuthorizationCode]: + 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 'retrieve_authorization_code' not in self._stubs: + self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveAuthorizationCode', + request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['retrieve_authorization_code'] + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + domains.AuthorizationCode]: + r"""Return a callable for the reset authorization code method over gRPC. + + Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.ResetAuthorizationCodeRequest], + ~.AuthorizationCode]: + 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 'reset_authorization_code' not in self._stubs: + self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ResetAuthorizationCode', + request_serializer=domains.ResetAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['reset_authorization_code'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'DomainsGrpcTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py new file mode 100644 index 0000000..d7e3347 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py @@ -0,0 +1,741 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.domains_v1beta1.types import domains +from google.longrunning import operations_pb2 # type: ignore +from .base import DomainsTransport, DEFAULT_CLIENT_INFO +from .grpc import DomainsGrpcTransport + + +class DomainsGrpcAsyncIOTransport(DomainsTransport): + """gRPC AsyncIO backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'domains.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + Awaitable[domains.SearchDomainsResponse]]: + r"""Return a callable for the search domains method over gRPC. + + Searches for available domain names similar to the provided + query. + + Availability results from this method are approximate; call + ``RetrieveRegisterParameters`` on a domain before registering to + confirm availability. + + Returns: + Callable[[~.SearchDomainsRequest], + Awaitable[~.SearchDomainsResponse]]: + 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_domains' not in self._stubs: + self._stubs['search_domains'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/SearchDomains', + request_serializer=domains.SearchDomainsRequest.serialize, + response_deserializer=domains.SearchDomainsResponse.deserialize, + ) + return self._stubs['search_domains'] + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + Awaitable[domains.RetrieveRegisterParametersResponse]]: + r"""Return a callable for the retrieve register parameters method over gRPC. + + Gets parameters needed to register a new domain name, including + price and up-to-date availability. Use the returned values to + call ``RegisterDomain``. + + Returns: + Callable[[~.RetrieveRegisterParametersRequest], + Awaitable[~.RetrieveRegisterParametersResponse]]: + 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 'retrieve_register_parameters' not in self._stubs: + self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveRegisterParameters', + request_serializer=domains.RetrieveRegisterParametersRequest.serialize, + response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, + ) + return self._stubs['retrieve_register_parameters'] + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the register domain method over gRPC. + + Registers a new domain name and creates a corresponding + ``Registration`` resource. + + Call ``RetrieveRegisterParameters`` first to check availability + of the domain name and determine parameters like price that are + needed to build a call to this method. + + A successful call creates a ``Registration`` resource in state + ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within + 1-2 minutes, indicating that the domain was successfully + registered. If the resource ends up in state + ``REGISTRATION_FAILED``, it indicates that the domain was not + registered successfully, and you can safely delete the resource + and retry registration. + + Returns: + Callable[[~.RegisterDomainRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_domain' not in self._stubs: + self._stubs['register_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RegisterDomain', + request_serializer=domains.RegisterDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['register_domain'] + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + Awaitable[domains.RetrieveTransferParametersResponse]]: + r"""Return a callable for the retrieve transfer parameters method over gRPC. + + Gets parameters needed to transfer a domain name from another + registrar to Cloud Domains. For domains managed by Google + Domains, transferring to Cloud Domains is not supported. + + Use the returned values to call ``TransferDomain``. + + Returns: + Callable[[~.RetrieveTransferParametersRequest], + Awaitable[~.RetrieveTransferParametersResponse]]: + 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 'retrieve_transfer_parameters' not in self._stubs: + self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveTransferParameters', + request_serializer=domains.RetrieveTransferParametersRequest.serialize, + response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, + ) + return self._stubs['retrieve_transfer_parameters'] + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the transfer domain method over gRPC. + + Transfers a domain name from another registrar to Cloud Domains. + For domains managed by Google Domains, transferring to Cloud + Domains is not supported. + + Before calling this method, go to the domain's current registrar + to unlock the domain for transfer and retrieve the domain's + transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to this + method. + + A successful call creates a ``Registration`` resource in state + ``TRANSFER_PENDING``. It can take several days to complete the + transfer process. The registrant can often speed up this process + by approving the transfer through the current registrar, either + by clicking a link in an email from the registrar or by visiting + the registrar's website. + + A few minutes after transfer approval, the resource transitions + to state ``ACTIVE``, indicating that the transfer was + successful. If the transfer is rejected or the request expires + without being approved, the resource can end up in state + ``TRANSFER_FAILED``. If transfer fails, you can safely delete + the resource and retry the transfer. + + Returns: + Callable[[~.TransferDomainRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'transfer_domain' not in self._stubs: + self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/TransferDomain', + request_serializer=domains.TransferDomainRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['transfer_domain'] + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + Awaitable[domains.ListRegistrationsResponse]]: + r"""Return a callable for the list registrations method over gRPC. + + Lists the ``Registration`` resources in a project. + + Returns: + Callable[[~.ListRegistrationsRequest], + Awaitable[~.ListRegistrationsResponse]]: + 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_registrations' not in self._stubs: + self._stubs['list_registrations'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ListRegistrations', + request_serializer=domains.ListRegistrationsRequest.serialize, + response_deserializer=domains.ListRegistrationsResponse.deserialize, + ) + return self._stubs['list_registrations'] + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + Awaitable[domains.Registration]]: + r"""Return a callable for the get registration method over gRPC. + + Gets the details of a ``Registration`` resource. + + Returns: + Callable[[~.GetRegistrationRequest], + Awaitable[~.Registration]]: + 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_registration' not in self._stubs: + self._stubs['get_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/GetRegistration', + request_serializer=domains.GetRegistrationRequest.serialize, + response_deserializer=domains.Registration.deserialize, + ) + return self._stubs['get_registration'] + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update registration method over gRPC. + + Updates select fields of a ``Registration`` resource, notably + ``labels``. To update other fields, use the appropriate custom + update method: + + - To update management settings, see + ``ConfigureManagementSettings`` + - To update DNS configuration, see ``ConfigureDnsSettings`` + - To update contact information, see + ``ConfigureContactSettings`` + + Returns: + Callable[[~.UpdateRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_registration' not in self._stubs: + self._stubs['update_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/UpdateRegistration', + request_serializer=domains.UpdateRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_registration'] + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure management settings method over gRPC. + + Updates a ``Registration``'s management settings. + + Returns: + Callable[[~.ConfigureManagementSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_management_settings' not in self._stubs: + self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureManagementSettings', + request_serializer=domains.ConfigureManagementSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_management_settings'] + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure dns settings method over gRPC. + + Updates a ``Registration``'s DNS settings. + + Returns: + Callable[[~.ConfigureDnsSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_dns_settings' not in self._stubs: + self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureDnsSettings', + request_serializer=domains.ConfigureDnsSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_dns_settings'] + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the configure contact settings method over gRPC. + + Updates a ``Registration``'s contact settings. Some changes + require confirmation by the domain's registrant contact . + + Returns: + Callable[[~.ConfigureContactSettingsRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'configure_contact_settings' not in self._stubs: + self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ConfigureContactSettings', + request_serializer=domains.ConfigureContactSettingsRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['configure_contact_settings'] + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the export registration method over gRPC. + + Exports a ``Registration`` resource, such that it is no longer + managed by Cloud Domains. + + When an active domain is successfully exported, you can continue + to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.ExportRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'export_registration' not in self._stubs: + self._stubs['export_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ExportRegistration', + request_serializer=domains.ExportRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['export_registration'] + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete registration method over gRPC. + + Deletes a ``Registration`` resource. + + This method works on any ``Registration`` resource using + `Subscription or Commitment + billing `__, provided that the + resource was created at least 1 day in the past. + + For ``Registration`` resources using `Monthly + billing `__, this method works + if: + + - ``state`` is ``EXPORTED`` with ``expire_time`` in the past + - ``state`` is ``REGISTRATION_FAILED`` + - ``state`` is ``TRANSFER_FAILED`` + + When an active registration is successfully deleted, you can + continue to use the domain in `Google + Domains `__ until it expires. The + calling user becomes the domain's sole owner in Google Domains, + and permissions for the domain are subsequently managed there. + The domain does not renew automatically unless the new owner + sets up billing in Google Domains. + + Returns: + Callable[[~.DeleteRegistrationRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_registration' not in self._stubs: + self._stubs['delete_registration'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/DeleteRegistration', + request_serializer=domains.DeleteRegistrationRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_registration'] + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + Awaitable[domains.AuthorizationCode]]: + r"""Return a callable for the retrieve authorization code method over gRPC. + + Gets the authorization code of the ``Registration`` for the + purpose of transferring the domain to another registrar. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.RetrieveAuthorizationCodeRequest], + Awaitable[~.AuthorizationCode]]: + 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 'retrieve_authorization_code' not in self._stubs: + self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/RetrieveAuthorizationCode', + request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['retrieve_authorization_code'] + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + Awaitable[domains.AuthorizationCode]]: + r"""Return a callable for the reset authorization code method over gRPC. + + Resets the authorization code of the ``Registration`` to a new + random string. + + You can call this method only after 60 days have elapsed since + the initial domain registration. + + Returns: + Callable[[~.ResetAuthorizationCodeRequest], + Awaitable[~.AuthorizationCode]]: + 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 'reset_authorization_code' not in self._stubs: + self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( + '/google.cloud.domains.v1beta1.Domains/ResetAuthorizationCode', + request_serializer=domains.ResetAuthorizationCodeRequest.serialize, + response_deserializer=domains.AuthorizationCode.deserialize, + ) + return self._stubs['reset_authorization_code'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'DomainsGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py new file mode 100644 index 0000000..1d1db6e --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py @@ -0,0 +1,1976 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.domains_v1beta1.types import domains +from google.longrunning import operations_pb2 # type: ignore + +from .base import DomainsTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class DomainsRestInterceptor: + """Interceptor for Domains. + + 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 DomainsRestTransport. + + .. code-block:: python + class MyCustomDomainsInterceptor(DomainsRestInterceptor): + def pre_configure_contact_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_contact_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_configure_dns_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_dns_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_configure_management_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_configure_management_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_export_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_export_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_registration(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_registrations(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_registrations(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_domain(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_domain(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_reset_authorization_code(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_reset_authorization_code(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_authorization_code(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_authorization_code(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_register_parameters(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_register_parameters(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_retrieve_transfer_parameters(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_retrieve_transfer_parameters(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_domains(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_domains(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_transfer_domain(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_transfer_domain(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_registration(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_registration(self, response): + logging.log(f"Received response: {response}") + return response + + transport = DomainsRestTransport(interceptor=MyCustomDomainsInterceptor()) + client = DomainsClient(transport=transport) + + + """ + def pre_configure_contact_settings(self, request: domains.ConfigureContactSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureContactSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_contact_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_contact_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_contact_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_configure_dns_settings(self, request: domains.ConfigureDnsSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureDnsSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_dns_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_dns_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_dns_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_configure_management_settings(self, request: domains.ConfigureManagementSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureManagementSettingsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for configure_management_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_configure_management_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for configure_management_settings + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_delete_registration(self, request: domains.DeleteRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.DeleteRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_delete_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_export_registration(self, request: domains.ExportRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ExportRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for export_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_export_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for export_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_get_registration(self, request: domains.GetRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.GetRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_get_registration(self, response: domains.Registration) -> domains.Registration: + """Post-rpc interceptor for get_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_list_registrations(self, request: domains.ListRegistrationsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ListRegistrationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_registrations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_list_registrations(self, response: domains.ListRegistrationsResponse) -> domains.ListRegistrationsResponse: + """Post-rpc interceptor for list_registrations + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_register_domain(self, request: domains.RegisterDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RegisterDomainRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_domain + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_register_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for register_domain + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_reset_authorization_code(self, request: domains.ResetAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ResetAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for reset_authorization_code + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_reset_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: + """Post-rpc interceptor for reset_authorization_code + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_authorization_code(self, request: domains.RetrieveAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_authorization_code + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: + """Post-rpc interceptor for retrieve_authorization_code + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_register_parameters(self, request: domains.RetrieveRegisterParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveRegisterParametersRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_register_parameters + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_register_parameters(self, response: domains.RetrieveRegisterParametersResponse) -> domains.RetrieveRegisterParametersResponse: + """Post-rpc interceptor for retrieve_register_parameters + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_retrieve_transfer_parameters(self, request: domains.RetrieveTransferParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveTransferParametersRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for retrieve_transfer_parameters + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_retrieve_transfer_parameters(self, response: domains.RetrieveTransferParametersResponse) -> domains.RetrieveTransferParametersResponse: + """Post-rpc interceptor for retrieve_transfer_parameters + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_search_domains(self, request: domains.SearchDomainsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.SearchDomainsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_domains + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_search_domains(self, response: domains.SearchDomainsResponse) -> domains.SearchDomainsResponse: + """Post-rpc interceptor for search_domains + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_transfer_domain(self, request: domains.TransferDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.TransferDomainRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for transfer_domain + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_transfer_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for transfer_domain + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + def pre_update_registration(self, request: domains.UpdateRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.UpdateRegistrationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the Domains server. + """ + return request, metadata + + def post_update_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_registration + + Override in a subclass to manipulate the response + after it is returned by the Domains server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class DomainsRestStub: + _session: AuthorizedSession + _host: str + _interceptor: DomainsRestInterceptor + + +class DomainsRestTransport(DomainsTransport): + """REST backend transport for Domains. + + The Cloud Domains API enables management and configuration of + domain names. + + 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 = 'domains.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[DomainsRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or DomainsRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v1beta1/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v1beta1/{name=projects/*/locations/*}/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1beta1") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _ConfigureContactSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureContactSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureContactSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure contact + settings method over HTTP. + + Args: + request (~.domains.ConfigureContactSettingsRequest): + The request object. Request for the ``ConfigureContactSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_contact_settings(request, metadata) + pb_request = domains.ConfigureContactSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_contact_settings(resp) + return resp + + class _ConfigureDnsSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureDnsSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureDnsSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure dns settings method over HTTP. + + Args: + request (~.domains.ConfigureDnsSettingsRequest): + The request object. Request for the ``ConfigureDnsSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_dns_settings(request, metadata) + pb_request = domains.ConfigureDnsSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_dns_settings(resp) + return resp + + class _ConfigureManagementSettings(DomainsRestStub): + def __hash__(self): + return hash("ConfigureManagementSettings") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ConfigureManagementSettingsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the configure management + settings method over HTTP. + + Args: + request (~.domains.ConfigureManagementSettingsRequest): + The request object. Request for the ``ConfigureManagementSettings`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_configure_management_settings(request, metadata) + pb_request = domains.ConfigureManagementSettingsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_configure_management_settings(resp) + return resp + + class _DeleteRegistration(DomainsRestStub): + def __hash__(self): + return hash("DeleteRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.DeleteRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete registration method over HTTP. + + Args: + request (~.domains.DeleteRegistrationRequest): + The request object. Request for the ``DeleteRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_registration(request, metadata) + pb_request = domains.DeleteRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_registration(resp) + return resp + + class _ExportRegistration(DomainsRestStub): + def __hash__(self): + return hash("ExportRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ExportRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the export registration method over HTTP. + + Args: + request (~.domains.ExportRegistrationRequest): + The request object. Request for the ``ExportRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}:export', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_export_registration(request, metadata) + pb_request = domains.ExportRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_export_registration(resp) + return resp + + class _GetRegistration(DomainsRestStub): + def __hash__(self): + return hash("GetRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.GetRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.Registration: + r"""Call the get registration method over HTTP. + + Args: + request (~.domains.GetRegistrationRequest): + The request object. Request for the ``GetRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.Registration: + The ``Registration`` resource facilitates managing and + configuring domain name registrations. + + There are several ways to create a new ``Registration`` + resource: + + To create a new ``Registration`` resource, find a + suitable domain name by calling the ``SearchDomains`` + method with a query to see available domain name + options. After choosing a name, call + ``RetrieveRegisterParameters`` to ensure availability + and obtain information like pricing, which is needed to + build a call to ``RegisterDomain``. + + Another way to create a new ``Registration`` is to + transfer an existing domain from another registrar. + First, go to the current registrar to unlock the domain + for transfer and retrieve the domain's transfer + authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the + domain is unlocked and to get values needed to build a + call to ``TransferDomain``. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}', + }, + ] + request, metadata = self._interceptor.pre_get_registration(request, metadata) + pb_request = domains.GetRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.Registration() + pb_resp = domains.Registration.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_registration(resp) + return resp + + class _ListRegistrations(DomainsRestStub): + def __hash__(self): + return hash("ListRegistrations") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ListRegistrationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.ListRegistrationsResponse: + r"""Call the list registrations method over HTTP. + + Args: + request (~.domains.ListRegistrationsRequest): + The request object. Request for the ``ListRegistrations`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.ListRegistrationsResponse: + Response for the ``ListRegistrations`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations', + }, + ] + request, metadata = self._interceptor.pre_list_registrations(request, metadata) + pb_request = domains.ListRegistrationsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.ListRegistrationsResponse() + pb_resp = domains.ListRegistrationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_registrations(resp) + return resp + + class _RegisterDomain(DomainsRestStub): + def __hash__(self): + return hash("RegisterDomain") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RegisterDomainRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the register domain method over HTTP. + + Args: + request (~.domains.RegisterDomainRequest): + The request object. Request for the ``RegisterDomain`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations:register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_domain(request, metadata) + pb_request = domains.RegisterDomainRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_domain(resp) + return resp + + class _ResetAuthorizationCode(DomainsRestStub): + def __hash__(self): + return hash("ResetAuthorizationCode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.ResetAuthorizationCodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.AuthorizationCode: + r"""Call the reset authorization code method over HTTP. + + Args: + request (~.domains.ResetAuthorizationCodeRequest): + The request object. Request for the ``ResetAuthorizationCode`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.AuthorizationCode: + Defines an authorization code. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_reset_authorization_code(request, metadata) + pb_request = domains.ResetAuthorizationCodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.AuthorizationCode() + pb_resp = domains.AuthorizationCode.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_reset_authorization_code(resp) + return resp + + class _RetrieveAuthorizationCode(DomainsRestStub): + def __hash__(self): + return hash("RetrieveAuthorizationCode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveAuthorizationCodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.AuthorizationCode: + r"""Call the retrieve authorization + code method over HTTP. + + Args: + request (~.domains.RetrieveAuthorizationCodeRequest): + The request object. Request for the ``RetrieveAuthorizationCode`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.AuthorizationCode: + Defines an authorization code. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode', + }, + ] + request, metadata = self._interceptor.pre_retrieve_authorization_code(request, metadata) + pb_request = domains.RetrieveAuthorizationCodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.AuthorizationCode() + pb_resp = domains.AuthorizationCode.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_authorization_code(resp) + return resp + + class _RetrieveRegisterParameters(DomainsRestStub): + def __hash__(self): + return hash("RetrieveRegisterParameters") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "domainName" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveRegisterParametersRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.RetrieveRegisterParametersResponse: + r"""Call the retrieve register + parameters method over HTTP. + + Args: + request (~.domains.RetrieveRegisterParametersRequest): + The request object. Request for the ``RetrieveRegisterParameters`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.RetrieveRegisterParametersResponse: + Response for the ``RetrieveRegisterParameters`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters', + }, + ] + request, metadata = self._interceptor.pre_retrieve_register_parameters(request, metadata) + pb_request = domains.RetrieveRegisterParametersRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.RetrieveRegisterParametersResponse() + pb_resp = domains.RetrieveRegisterParametersResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_register_parameters(resp) + return resp + + class _RetrieveTransferParameters(DomainsRestStub): + def __hash__(self): + return hash("RetrieveTransferParameters") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "domainName" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.RetrieveTransferParametersRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.RetrieveTransferParametersResponse: + r"""Call the retrieve transfer + parameters method over HTTP. + + Args: + request (~.domains.RetrieveTransferParametersRequest): + The request object. Request for the ``RetrieveTransferParameters`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.RetrieveTransferParametersResponse: + Response for the ``RetrieveTransferParameters`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters', + }, + ] + request, metadata = self._interceptor.pre_retrieve_transfer_parameters(request, metadata) + pb_request = domains.RetrieveTransferParametersRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.RetrieveTransferParametersResponse() + pb_resp = domains.RetrieveTransferParametersResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_retrieve_transfer_parameters(resp) + return resp + + class _SearchDomains(DomainsRestStub): + def __hash__(self): + return hash("SearchDomains") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "query" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.SearchDomainsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> domains.SearchDomainsResponse: + r"""Call the search domains method over HTTP. + + Args: + request (~.domains.SearchDomainsRequest): + The request object. Request for the ``SearchDomains`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.domains.SearchDomainsResponse: + Response for the ``SearchDomains`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:searchDomains', + }, + ] + request, metadata = self._interceptor.pre_search_domains(request, metadata) + pb_request = domains.SearchDomainsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = domains.SearchDomainsResponse() + pb_resp = domains.SearchDomainsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_domains(resp) + return resp + + class _TransferDomain(DomainsRestStub): + def __hash__(self): + return hash("TransferDomain") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.TransferDomainRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the transfer domain method over HTTP. + + Args: + request (~.domains.TransferDomainRequest): + The request object. Request for the ``TransferDomain`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations:transfer', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_transfer_domain(request, metadata) + pb_request = domains.TransferDomainRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_transfer_domain(resp) + return resp + + class _UpdateRegistration(DomainsRestStub): + def __hash__(self): + return hash("UpdateRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "updateMask" : {}, } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: domains.UpdateRegistrationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update registration method over HTTP. + + Args: + request (~.domains.UpdateRegistrationRequest): + The request object. Request for the ``UpdateRegistration`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1beta1/{registration.name=projects/*/locations/*/registrations/*}', + 'body': 'registration', + }, + ] + request, metadata = self._interceptor.pre_update_registration(request, metadata) + pb_request = domains.UpdateRegistrationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_registration(resp) + return resp + + @property + def configure_contact_settings(self) -> Callable[ + [domains.ConfigureContactSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureContactSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def configure_dns_settings(self) -> Callable[ + [domains.ConfigureDnsSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureDnsSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def configure_management_settings(self) -> Callable[ + [domains.ConfigureManagementSettingsRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ConfigureManagementSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_registration(self) -> Callable[ + [domains.DeleteRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def export_registration(self) -> Callable[ + [domains.ExportRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ExportRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_registration(self) -> Callable[ + [domains.GetRegistrationRequest], + domains.Registration]: + # 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._GetRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_registrations(self) -> Callable[ + [domains.ListRegistrationsRequest], + domains.ListRegistrationsResponse]: + # 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._ListRegistrations(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_domain(self) -> Callable[ + [domains.RegisterDomainRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDomain(self._session, self._host, self._interceptor) # type: ignore + + @property + def reset_authorization_code(self) -> Callable[ + [domains.ResetAuthorizationCodeRequest], + domains.AuthorizationCode]: + # 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._ResetAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_authorization_code(self) -> Callable[ + [domains.RetrieveAuthorizationCodeRequest], + domains.AuthorizationCode]: + # 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._RetrieveAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_register_parameters(self) -> Callable[ + [domains.RetrieveRegisterParametersRequest], + domains.RetrieveRegisterParametersResponse]: + # 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._RetrieveRegisterParameters(self._session, self._host, self._interceptor) # type: ignore + + @property + def retrieve_transfer_parameters(self) -> Callable[ + [domains.RetrieveTransferParametersRequest], + domains.RetrieveTransferParametersResponse]: + # 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._RetrieveTransferParameters(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_domains(self) -> Callable[ + [domains.SearchDomainsRequest], + domains.SearchDomainsResponse]: + # 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._SearchDomains(self._session, self._host, self._interceptor) # type: ignore + + @property + def transfer_domain(self) -> Callable[ + [domains.TransferDomainRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._TransferDomain(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_registration(self) -> Callable[ + [domains.UpdateRegistrationRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'DomainsRestTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py new file mode 100644 index 0000000..cb45e82 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py @@ -0,0 +1,82 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .domains import ( + AuthorizationCode, + ConfigureContactSettingsRequest, + ConfigureDnsSettingsRequest, + ConfigureManagementSettingsRequest, + ContactSettings, + DeleteRegistrationRequest, + DnsSettings, + ExportRegistrationRequest, + GetRegistrationRequest, + ListRegistrationsRequest, + ListRegistrationsResponse, + ManagementSettings, + OperationMetadata, + RegisterDomainRequest, + RegisterParameters, + Registration, + ResetAuthorizationCodeRequest, + RetrieveAuthorizationCodeRequest, + RetrieveRegisterParametersRequest, + RetrieveRegisterParametersResponse, + RetrieveTransferParametersRequest, + RetrieveTransferParametersResponse, + SearchDomainsRequest, + SearchDomainsResponse, + TransferDomainRequest, + TransferParameters, + UpdateRegistrationRequest, + ContactNotice, + ContactPrivacy, + DomainNotice, + TransferLockState, +) + +__all__ = ( + 'AuthorizationCode', + 'ConfigureContactSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureManagementSettingsRequest', + 'ContactSettings', + 'DeleteRegistrationRequest', + 'DnsSettings', + 'ExportRegistrationRequest', + 'GetRegistrationRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'ManagementSettings', + 'OperationMetadata', + 'RegisterDomainRequest', + 'RegisterParameters', + 'Registration', + 'ResetAuthorizationCodeRequest', + 'RetrieveAuthorizationCodeRequest', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'TransferDomainRequest', + 'TransferParameters', + 'UpdateRegistrationRequest', + 'ContactNotice', + 'ContactPrivacy', + 'DomainNotice', + 'TransferLockState', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py new file mode 100644 index 0000000..282503d --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py @@ -0,0 +1,1523 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from google.type import postal_address_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.domains.v1beta1', + manifest={ + 'ContactPrivacy', + 'DomainNotice', + 'ContactNotice', + 'TransferLockState', + 'Registration', + 'ManagementSettings', + 'DnsSettings', + 'ContactSettings', + 'SearchDomainsRequest', + 'SearchDomainsResponse', + 'RetrieveRegisterParametersRequest', + 'RetrieveRegisterParametersResponse', + 'RegisterDomainRequest', + 'RetrieveTransferParametersRequest', + 'RetrieveTransferParametersResponse', + 'TransferDomainRequest', + 'ListRegistrationsRequest', + 'ListRegistrationsResponse', + 'GetRegistrationRequest', + 'UpdateRegistrationRequest', + 'ConfigureManagementSettingsRequest', + 'ConfigureDnsSettingsRequest', + 'ConfigureContactSettingsRequest', + 'ExportRegistrationRequest', + 'DeleteRegistrationRequest', + 'RetrieveAuthorizationCodeRequest', + 'ResetAuthorizationCodeRequest', + 'RegisterParameters', + 'TransferParameters', + 'AuthorizationCode', + 'OperationMetadata', + }, +) + + +class ContactPrivacy(proto.Enum): + r"""Defines a set of possible contact privacy settings for a + ``Registration``. + + `ICANN `__ maintains the WHOIS database, a + publicly accessible mapping from domain name to contact information, + and requires that each domain name have an entry. Choose from these + options to control how much information in your ``ContactSettings`` + is published. + + Values: + CONTACT_PRIVACY_UNSPECIFIED (0): + The contact privacy settings are undefined. + PUBLIC_CONTACT_DATA (1): + All the data from ``ContactSettings`` is publicly available. + When setting this option, you must also provide a + ``PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT`` in the + ``contact_notices`` field of the request. + PRIVATE_CONTACT_DATA (2): + None of the data from ``ContactSettings`` is publicly + available. Instead, proxy contact data is published for your + domain. Email sent to the proxy email address is forwarded + to the registrant's email address. Cloud Domains provides + this privacy proxy service at no additional cost. + REDACTED_CONTACT_DATA (3): + Some data from ``ContactSettings`` is publicly available. + The actual information redacted depends on the domain. For + details, see `the registration privacy + article `__. + """ + CONTACT_PRIVACY_UNSPECIFIED = 0 + PUBLIC_CONTACT_DATA = 1 + PRIVATE_CONTACT_DATA = 2 + REDACTED_CONTACT_DATA = 3 + + +class DomainNotice(proto.Enum): + r"""Notices about special properties of certain domains. + + Values: + DOMAIN_NOTICE_UNSPECIFIED (0): + The notice is undefined. + HSTS_PRELOADED (1): + Indicates that the domain is preloaded on the HTTP Strict + Transport Security list in browsers. Serving a website on + such domain requires an SSL certificate. For details, see + `how to get an SSL + certificate `__. + """ + DOMAIN_NOTICE_UNSPECIFIED = 0 + HSTS_PRELOADED = 1 + + +class ContactNotice(proto.Enum): + r"""Notices related to contact information. + + Values: + CONTACT_NOTICE_UNSPECIFIED (0): + The notice is undefined. + PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1): + Required when setting the ``privacy`` field of + ``ContactSettings`` to ``PUBLIC_CONTACT_DATA``, which + exposes contact data publicly. + """ + CONTACT_NOTICE_UNSPECIFIED = 0 + PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT = 1 + + +class TransferLockState(proto.Enum): + r"""Possible states of a ``Registration``'s transfer lock. + + Values: + TRANSFER_LOCK_STATE_UNSPECIFIED (0): + The state is unspecified. + UNLOCKED (1): + The domain is unlocked and can be transferred + to another registrar. + LOCKED (2): + The domain is locked and cannot be + transferred to another registrar. + """ + TRANSFER_LOCK_STATE_UNSPECIFIED = 0 + UNLOCKED = 1 + LOCKED = 2 + + +class Registration(proto.Message): + r"""The ``Registration`` resource facilitates managing and configuring + domain name registrations. + + There are several ways to create a new ``Registration`` resource: + + To create a new ``Registration`` resource, find a suitable domain + name by calling the ``SearchDomains`` method with a query to see + available domain name options. After choosing a name, call + ``RetrieveRegisterParameters`` to ensure availability and obtain + information like pricing, which is needed to build a call to + ``RegisterDomain``. + + Another way to create a new ``Registration`` is to transfer an + existing domain from another registrar. First, go to the current + registrar to unlock the domain for transfer and retrieve the + domain's transfer authorization code. Then call + ``RetrieveTransferParameters`` to confirm that the domain is + unlocked and to get values needed to build a call to + ``TransferDomain``. + + Attributes: + name (str): + Output only. Name of the ``Registration`` resource, in the + format + ``projects/*/locations/*/registrations/``. + domain_name (str): + Required. Immutable. The domain name. Unicode + domain names must be expressed in Punycode + format. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The creation timestamp of the ``Registration`` + resource. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The expiration timestamp of the + ``Registration``. + state (google.cloud.domains_v1beta1.types.Registration.State): + Output only. The state of the ``Registration`` + issues (MutableSequence[google.cloud.domains_v1beta1.types.Registration.Issue]): + Output only. The set of issues with the ``Registration`` + that require attention. + labels (MutableMapping[str, str]): + Set of labels associated with the ``Registration``. + management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): + Settings for management of the ``Registration``, including + renewal, billing, and transfer. You cannot update these with + the ``UpdateRegistration`` method. To update these settings, + use the ``ConfigureManagementSettings`` method. + dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): + Settings controlling the DNS configuration of the + ``Registration``. You cannot update these with the + ``UpdateRegistration`` method. To update these settings, use + the ``ConfigureDnsSettings`` method. + contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): + Required. Settings for contact information linked to the + ``Registration``. You cannot update these with the + ``UpdateRegistration`` method. To update these settings, use + the ``ConfigureContactSettings`` method. + pending_contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): + Output only. Pending contact settings for the + ``Registration``. Updates to the ``contact_settings`` field + that change its ``registrant_contact`` or ``privacy`` fields + require email confirmation by the ``registrant_contact`` + before taking effect. This field is set only if there are + pending updates to the ``contact_settings`` that have not + been confirmed. To confirm the changes, the + ``registrant_contact`` must follow the instructions in the + email they receive. + supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): + Output only. Set of options for the + ``contact_settings.privacy`` field that this + ``Registration`` supports. + """ + class State(proto.Enum): + r"""Possible states of a ``Registration``. + + Values: + STATE_UNSPECIFIED (0): + The state is undefined. + REGISTRATION_PENDING (1): + The domain is being registered. + REGISTRATION_FAILED (2): + The domain registration failed. You can + delete resources in this state to allow + registration to be retried. + TRANSFER_PENDING (3): + The domain is being transferred from another + registrar to Cloud Domains. + TRANSFER_FAILED (4): + The attempt to transfer the domain from + another registrar to Cloud Domains failed. You + can delete resources in this state and retry the + transfer. + ACTIVE (6): + The domain is registered and operational. The + domain renews automatically as long as it + remains in this state. + SUSPENDED (7): + The domain is suspended and inoperative. For more details, + see the ``issues`` field. + EXPORTED (8): + The domain is no longer managed with Cloud Domains. It may + have been transferred to another registrar or exported for + management in `Google Domains `__. + You can no longer update it with this API, and information + shown about it may be stale. Domains in this state are not + automatically renewed by Cloud Domains. + """ + STATE_UNSPECIFIED = 0 + REGISTRATION_PENDING = 1 + REGISTRATION_FAILED = 2 + TRANSFER_PENDING = 3 + TRANSFER_FAILED = 4 + ACTIVE = 6 + SUSPENDED = 7 + EXPORTED = 8 + + class Issue(proto.Enum): + r"""Possible issues with a ``Registration`` that require attention. + + Values: + ISSUE_UNSPECIFIED (0): + The issue is undefined. + CONTACT_SUPPORT (1): + Contact the Cloud Support team to resolve a + problem with this domain. + UNVERIFIED_EMAIL (2): + `ICANN `__ requires verification of the + email address in the ``Registration``'s + ``contact_settings.registrant_contact`` field. To verify the + email address, follow the instructions in the email the + ``registrant_contact`` receives following registration. If + you do not complete email verification within 15 days of + registration, the domain is suspended. To resend the + verification email, call ConfigureContactSettings and + provide the current ``registrant_contact.email``. + """ + ISSUE_UNSPECIFIED = 0 + CONTACT_SUPPORT = 1 + UNVERIFIED_EMAIL = 2 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + domain_name: str = proto.Field( + proto.STRING, + number=2, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + expire_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + state: State = proto.Field( + proto.ENUM, + number=7, + enum=State, + ) + issues: MutableSequence[Issue] = proto.RepeatedField( + proto.ENUM, + number=8, + enum=Issue, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=9, + ) + management_settings: 'ManagementSettings' = proto.Field( + proto.MESSAGE, + number=10, + message='ManagementSettings', + ) + dns_settings: 'DnsSettings' = proto.Field( + proto.MESSAGE, + number=11, + message='DnsSettings', + ) + contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=12, + message='ContactSettings', + ) + pending_contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=13, + message='ContactSettings', + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=14, + enum='ContactPrivacy', + ) + + +class ManagementSettings(proto.Message): + r"""Defines renewal, billing, and transfer settings for a + ``Registration``. + + Attributes: + renewal_method (google.cloud.domains_v1beta1.types.ManagementSettings.RenewalMethod): + Output only. The renewal method for this ``Registration``. + transfer_lock_state (google.cloud.domains_v1beta1.types.TransferLockState): + Controls whether the domain can be + transferred to another registrar. + """ + class RenewalMethod(proto.Enum): + r"""Defines how the ``Registration`` is renewed. + + Values: + RENEWAL_METHOD_UNSPECIFIED (0): + The renewal method is undefined. + AUTOMATIC_RENEWAL (1): + The domain is automatically renewed each year . + + To disable automatic renewals, delete the resource by + calling ``DeleteRegistration`` or export it by calling + ``ExportRegistration``. + MANUAL_RENEWAL (2): + The domain must be explicitly renewed each year before its + ``expire_time``. This option is only available when the + ``Registration`` is in state ``EXPORTED``. + + To manage the domain's current billing and renewal settings, + go to `Google Domains `__. + """ + RENEWAL_METHOD_UNSPECIFIED = 0 + AUTOMATIC_RENEWAL = 1 + MANUAL_RENEWAL = 2 + + renewal_method: RenewalMethod = proto.Field( + proto.ENUM, + number=3, + enum=RenewalMethod, + ) + transfer_lock_state: 'TransferLockState' = proto.Field( + proto.ENUM, + number=4, + enum='TransferLockState', + ) + + +class DnsSettings(proto.Message): + r"""Defines the DNS configuration of a ``Registration``, including name + servers, DNSSEC, and glue records. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + custom_dns (google.cloud.domains_v1beta1.types.DnsSettings.CustomDns): + An arbitrary DNS provider identified by its + name servers. + + This field is a member of `oneof`_ ``dns_provider``. + google_domains_dns (google.cloud.domains_v1beta1.types.DnsSettings.GoogleDomainsDns): + The free DNS zone provided by `Google + Domains `__. + + This field is a member of `oneof`_ ``dns_provider``. + glue_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.GlueRecord]): + The list of glue records for this ``Registration``. Commonly + empty. + """ + class DsState(proto.Enum): + r"""The publication state of DS records for a ``Registration``. + + Values: + DS_STATE_UNSPECIFIED (0): + DS state is unspecified. + DS_RECORDS_UNPUBLISHED (1): + DNSSEC is disabled for this domain. No DS + records for this domain are published in the + parent DNS zone. + DS_RECORDS_PUBLISHED (2): + DNSSEC is enabled for this domain. Appropriate DS records + for this domain are published in the parent DNS zone. This + option is valid only if the DNS zone referenced in the + ``Registration``'s ``dns_provider`` field is already + DNSSEC-signed. + """ + DS_STATE_UNSPECIFIED = 0 + DS_RECORDS_UNPUBLISHED = 1 + DS_RECORDS_PUBLISHED = 2 + + class CustomDns(proto.Message): + r"""Configuration for an arbitrary DNS provider. + + Attributes: + name_servers (MutableSequence[str]): + Required. A list of name servers that store + the DNS zone for this domain. Each name server + is a domain name, with Unicode domain names + expressed in Punycode format. + ds_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.DsRecord]): + The list of DS records for this domain, which + are used to enable DNSSEC. The domain's DNS + provider can provide the values to set here. If + this field is empty, DNSSEC is disabled. + """ + + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='DnsSettings.DsRecord', + ) + + class GoogleDomainsDns(proto.Message): + r"""Configuration for using the free DNS zone provided by Google Domains + as a ``Registration``'s ``dns_provider``. You cannot configure the + DNS zone itself using the API. To configure the DNS zone, go to + `Google Domains `__. + + Attributes: + name_servers (MutableSequence[str]): + Output only. A list of name servers that + store the DNS zone for this domain. Each name + server is a domain name, with Unicode domain + names expressed in Punycode format. This field + is automatically populated with the name servers + assigned to the Google Domains DNS zone. + ds_state (google.cloud.domains_v1beta1.types.DnsSettings.DsState): + Required. The state of DS records for this + domain. Used to enable or disable automatic + DNSSEC. + ds_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.DsRecord]): + Output only. The list of DS records published for this + domain. The list is automatically populated when + ``ds_state`` is ``DS_RECORDS_PUBLISHED``, otherwise it + remains empty. + """ + + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + ds_state: 'DnsSettings.DsState' = proto.Field( + proto.ENUM, + number=2, + enum='DnsSettings.DsState', + ) + ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='DnsSettings.DsRecord', + ) + + class DsRecord(proto.Message): + r"""Defines a Delegation Signer (DS) record, which is needed to + enable DNSSEC for a domain. It contains a digest (hash) of a + DNSKEY record that must be present in the domain's DNS zone. + + Attributes: + key_tag (int): + The key tag of the record. Must be set in + range 0 -- 65535. + algorithm (google.cloud.domains_v1beta1.types.DnsSettings.DsRecord.Algorithm): + The algorithm used to generate the referenced + DNSKEY. + digest_type (google.cloud.domains_v1beta1.types.DnsSettings.DsRecord.DigestType): + The hash function used to generate the digest + of the referenced DNSKEY. + digest (str): + The digest generated from the referenced + DNSKEY. + """ + class Algorithm(proto.Enum): + r"""List of algorithms used to create a DNSKEY. Certain + algorithms are not supported for particular domains. + + Values: + ALGORITHM_UNSPECIFIED (0): + The algorithm is unspecified. + RSAMD5 (1): + RSA/MD5. Cannot be used for new deployments. + DH (2): + Diffie-Hellman. Cannot be used for new + deployments. + DSA (3): + DSA/SHA1. Not recommended for new + deployments. + ECC (4): + ECC. Not recommended for new deployments. + RSASHA1 (5): + RSA/SHA-1. Not recommended for new + deployments. + DSANSEC3SHA1 (6): + DSA-NSEC3-SHA1. Not recommended for new + deployments. + RSASHA1NSEC3SHA1 (7): + RSA/SHA1-NSEC3-SHA1. Not recommended for new + deployments. + RSASHA256 (8): + RSA/SHA-256. + RSASHA512 (10): + RSA/SHA-512. + ECCGOST (12): + GOST R 34.10-2001. + ECDSAP256SHA256 (13): + ECDSA Curve P-256 with SHA-256. + ECDSAP384SHA384 (14): + ECDSA Curve P-384 with SHA-384. + ED25519 (15): + Ed25519. + ED448 (16): + Ed448. + INDIRECT (252): + Reserved for Indirect Keys. Cannot be used + for new deployments. + PRIVATEDNS (253): + Private algorithm. Cannot be used for new + deployments. + PRIVATEOID (254): + Private algorithm OID. Cannot be used for new + deployments. + """ + ALGORITHM_UNSPECIFIED = 0 + RSAMD5 = 1 + DH = 2 + DSA = 3 + ECC = 4 + RSASHA1 = 5 + DSANSEC3SHA1 = 6 + RSASHA1NSEC3SHA1 = 7 + RSASHA256 = 8 + RSASHA512 = 10 + ECCGOST = 12 + ECDSAP256SHA256 = 13 + ECDSAP384SHA384 = 14 + ED25519 = 15 + ED448 = 16 + INDIRECT = 252 + PRIVATEDNS = 253 + PRIVATEOID = 254 + + class DigestType(proto.Enum): + r"""List of hash functions that may have been used to generate a + digest of a DNSKEY. + + Values: + DIGEST_TYPE_UNSPECIFIED (0): + The DigestType is unspecified. + SHA1 (1): + SHA-1. Not recommended for new deployments. + SHA256 (2): + SHA-256. + GOST3411 (3): + GOST R 34.11-94. + SHA384 (4): + SHA-384. + """ + DIGEST_TYPE_UNSPECIFIED = 0 + SHA1 = 1 + SHA256 = 2 + GOST3411 = 3 + SHA384 = 4 + + key_tag: int = proto.Field( + proto.INT32, + number=1, + ) + algorithm: 'DnsSettings.DsRecord.Algorithm' = proto.Field( + proto.ENUM, + number=2, + enum='DnsSettings.DsRecord.Algorithm', + ) + digest_type: 'DnsSettings.DsRecord.DigestType' = proto.Field( + proto.ENUM, + number=3, + enum='DnsSettings.DsRecord.DigestType', + ) + digest: str = proto.Field( + proto.STRING, + number=4, + ) + + class GlueRecord(proto.Message): + r"""Defines a host on your domain that is a DNS name server for your + domain and/or other domains. Glue records are a way of making the IP + address of a name server known, even when it serves DNS queries for + its parent domain. For example, when ``ns.example.com`` is a name + server for ``example.com``, the host ``ns.example.com`` must have a + glue record to break the circular DNS reference. + + Attributes: + host_name (str): + Required. Domain name of the host in Punycode + format. + ipv4_addresses (MutableSequence[str]): + List of IPv4 addresses corresponding to this host in the + standard decimal format (e.g. ``198.51.100.1``). At least + one of ``ipv4_address`` and ``ipv6_address`` must be set. + ipv6_addresses (MutableSequence[str]): + List of IPv6 addresses corresponding to this host in the + standard hexadecimal format (e.g. ``2001:db8::``). At least + one of ``ipv4_address`` and ``ipv6_address`` must be set. + """ + + host_name: str = proto.Field( + proto.STRING, + number=1, + ) + ipv4_addresses: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + ipv6_addresses: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + custom_dns: CustomDns = proto.Field( + proto.MESSAGE, + number=1, + oneof='dns_provider', + message=CustomDns, + ) + google_domains_dns: GoogleDomainsDns = proto.Field( + proto.MESSAGE, + number=2, + oneof='dns_provider', + message=GoogleDomainsDns, + ) + glue_records: MutableSequence[GlueRecord] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message=GlueRecord, + ) + + +class ContactSettings(proto.Message): + r"""Defines the contact information associated with a ``Registration``. + + `ICANN `__ requires all domain names to have + associated contact information. The ``registrant_contact`` is + considered the domain's legal owner, and often the other contacts + are identical. + + Attributes: + privacy (google.cloud.domains_v1beta1.types.ContactPrivacy): + Required. Privacy setting for the contacts associated with + the ``Registration``. + registrant_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): + Required. The registrant contact for the ``Registration``. + + *Caution: Anyone with access to this email address, phone + number, and/or postal address can take control of the + domain.* + + *Warning: For new ``Registration``\ s, the registrant + receives an email confirmation that they must complete + within 15 days to avoid domain suspension.* + admin_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): + Required. The administrative contact for the + ``Registration``. + technical_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): + Required. The technical contact for the ``Registration``. + """ + + class Contact(proto.Message): + r"""Details required for a contact associated with a ``Registration``. + + Attributes: + postal_address (google.type.postal_address_pb2.PostalAddress): + Required. Postal address of the contact. + email (str): + Required. Email address of the contact. + phone_number (str): + Required. Phone number of the contact in international + format. For example, ``"+1-800-555-0123"``. + fax_number (str): + Fax number of the contact in international format. For + example, ``"+1-800-555-0123"``. + """ + + postal_address: postal_address_pb2.PostalAddress = proto.Field( + proto.MESSAGE, + number=1, + message=postal_address_pb2.PostalAddress, + ) + email: str = proto.Field( + proto.STRING, + number=2, + ) + phone_number: str = proto.Field( + proto.STRING, + number=3, + ) + fax_number: str = proto.Field( + proto.STRING, + number=4, + ) + + privacy: 'ContactPrivacy' = proto.Field( + proto.ENUM, + number=1, + enum='ContactPrivacy', + ) + registrant_contact: Contact = proto.Field( + proto.MESSAGE, + number=2, + message=Contact, + ) + admin_contact: Contact = proto.Field( + proto.MESSAGE, + number=3, + message=Contact, + ) + technical_contact: Contact = proto.Field( + proto.MESSAGE, + number=4, + message=Contact, + ) + + +class SearchDomainsRequest(proto.Message): + r"""Request for the ``SearchDomains`` method. + + Attributes: + query (str): + Required. String used to search for available + domain names. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + query: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchDomainsResponse(proto.Message): + r"""Response for the ``SearchDomains`` method. + + Attributes: + register_parameters (MutableSequence[google.cloud.domains_v1beta1.types.RegisterParameters]): + Results of the domain name search. + """ + + register_parameters: MutableSequence['RegisterParameters'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RegisterParameters', + ) + + +class RetrieveRegisterParametersRequest(proto.Message): + r"""Request for the ``RetrieveRegisterParameters`` method. + + Attributes: + domain_name (str): + Required. The domain name. Unicode domain + names must be expressed in Punycode format. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RetrieveRegisterParametersResponse(proto.Message): + r"""Response for the ``RetrieveRegisterParameters`` method. + + Attributes: + register_parameters (google.cloud.domains_v1beta1.types.RegisterParameters): + Parameters to use when calling the ``RegisterDomain`` + method. + """ + + register_parameters: 'RegisterParameters' = proto.Field( + proto.MESSAGE, + number=1, + message='RegisterParameters', + ) + + +class RegisterDomainRequest(proto.Message): + r"""Request for the ``RegisterDomain`` method. + + Attributes: + parent (str): + Required. The parent resource of the ``Registration``. Must + be in the format ``projects/*/locations/*``. + registration (google.cloud.domains_v1beta1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + domain_notices (MutableSequence[google.cloud.domains_v1beta1.types.DomainNotice]): + The list of domain notices that you acknowledge. Call + ``RetrieveRegisterParameters`` to see the notices that need + acknowledgement. + contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): + The list of contact notices that the caller acknowledges. + The notices needed here depend on the values specified in + ``registration.contact_settings``. + yearly_price (google.type.money_pb2.Money): + Required. Yearly price to register or renew + the domain. The value that should be put here + can be obtained from RetrieveRegisterParameters + or SearchDomains calls. + validate_only (bool): + When true, only validation is performed, without actually + registering the domain. Follows: + https://cloud.google.com/apis/design/design_patterns#request_validation + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=2, + message='Registration', + ) + domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='DomainNotice', + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='ContactNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=5, + message=money_pb2.Money, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=6, + ) + + +class RetrieveTransferParametersRequest(proto.Message): + r"""Request for the ``RetrieveTransferParameters`` method. + + Attributes: + domain_name (str): + Required. The domain name. Unicode domain + names must be expressed in Punycode format. + location (str): + Required. The location. Must be in the format + ``projects/*/locations/*``. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + location: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RetrieveTransferParametersResponse(proto.Message): + r"""Response for the ``RetrieveTransferParameters`` method. + + Attributes: + transfer_parameters (google.cloud.domains_v1beta1.types.TransferParameters): + Parameters to use when calling the ``TransferDomain`` + method. + """ + + transfer_parameters: 'TransferParameters' = proto.Field( + proto.MESSAGE, + number=1, + message='TransferParameters', + ) + + +class TransferDomainRequest(proto.Message): + r"""Request for the ``TransferDomain`` method. + + Attributes: + parent (str): + Required. The parent resource of the ``Registration``. Must + be in the format ``projects/*/locations/*``. + registration (google.cloud.domains_v1beta1.types.Registration): + Required. The complete ``Registration`` resource to be + created. + + You can leave ``registration.dns_settings`` unset to import + the domain's current DNS configuration from its current + registrar. Use this option only if you are sure that the + domain's current DNS service does not cease upon transfer, + as is often the case for DNS services provided for free by + the registrar. + contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): + The list of contact notices that you acknowledge. The + notices needed here depend on the values specified in + ``registration.contact_settings``. + yearly_price (google.type.money_pb2.Money): + Required. Acknowledgement of the price to transfer or renew + the domain for one year. Call ``RetrieveTransferParameters`` + to obtain the price, which you must acknowledge. + authorization_code (google.cloud.domains_v1beta1.types.AuthorizationCode): + The domain's transfer authorization code. You + can obtain this from the domain's current + registrar. + validate_only (bool): + Validate the request without actually + transferring the domain. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=2, + message='Registration', + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='ContactNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=4, + message=money_pb2.Money, + ) + authorization_code: 'AuthorizationCode' = proto.Field( + proto.MESSAGE, + number=5, + message='AuthorizationCode', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=6, + ) + + +class ListRegistrationsRequest(proto.Message): + r"""Request for the ``ListRegistrations`` method. + + Attributes: + parent (str): + Required. The project and location from which to list + ``Registration``\ s, specified in the format + ``projects/*/locations/*``. + page_size (int): + Maximum number of results to return. + page_token (str): + When set to the ``next_page_token`` from a prior response, + provides the next page of results. + filter (str): + Filter expression to restrict the ``Registration``\ s + returned. + + The expression must specify the field name, a comparison + operator, and the value that you want to use for filtering. + The value must be a string, a number, a boolean, or an enum + value. The comparison operator should be one of =, !=, >, <, + >=, <=, or : for prefix or wildcard matches. + + For example, to filter to a specific domain name, use an + expression like ``domainName="example.com"``. You can also + check for the existence of a field; for example, to find + domains using custom DNS settings, use an expression like + ``dnsSettings.customDns:*``. + + You can also create compound filters by combining + expressions with the ``AND`` and ``OR`` operators. For + example, to find domains that are suspended or have specific + issues flagged, use an expression like + ``(state=SUSPENDED) OR (issue:*)``. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListRegistrationsResponse(proto.Message): + r"""Response for the ``ListRegistrations`` method. + + Attributes: + registrations (MutableSequence[google.cloud.domains_v1beta1.types.Registration]): + A list of ``Registration``\ s. + next_page_token (str): + When present, there are more results to retrieve. Set + ``page_token`` to this value on a subsequent call to get the + next page of results. + """ + + @property + def raw_page(self): + return self + + registrations: MutableSequence['Registration'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Registration', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRegistrationRequest(proto.Message): + r"""Request for the ``GetRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to get, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateRegistrationRequest(proto.Message): + r"""Request for the ``UpdateRegistration`` method. + + Attributes: + registration (google.cloud.domains_v1beta1.types.Registration): + Fields of the ``Registration`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the labels + are being updated, the ``update_mask`` is ``"labels"``. + """ + + registration: 'Registration' = proto.Field( + proto.MESSAGE, + number=1, + message='Registration', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class ConfigureManagementSettingsRequest(proto.Message): + r"""Request for the ``ConfigureManagementSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose management + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): + Fields of the ``ManagementSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the transfer + lock is being updated, the ``update_mask`` is + ``"transfer_lock_state"``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + management_settings: 'ManagementSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='ManagementSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + + +class ConfigureDnsSettingsRequest(proto.Message): + r"""Request for the ``ConfigureDnsSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose DNS + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): + Fields of the ``DnsSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the name + servers are being updated for an existing Custom DNS + configuration, the ``update_mask`` is + ``"custom_dns.name_servers"``. + + When changing the DNS provider from one type to another, + pass the new provider's field name as part of the field + mask. For example, when changing from a Google Domains DNS + configuration to a Custom DNS configuration, the + ``update_mask`` is ``"custom_dns"``. // + validate_only (bool): + Validate the request without actually + updating the DNS settings. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + dns_settings: 'DnsSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='DnsSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ConfigureContactSettingsRequest(proto.Message): + r"""Request for the ``ConfigureContactSettings`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose contact + settings are being updated, in the format + ``projects/*/locations/*/registrations/*``. + contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): + Fields of the ``ContactSettings`` to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. The field mask describing which fields to update + as a comma-separated list. For example, if only the + registrant contact is being updated, the ``update_mask`` is + ``"registrant_contact"``. + contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): + The list of contact notices that the caller acknowledges. + The notices needed here depend on the values specified in + ``contact_settings``. + validate_only (bool): + Validate the request without actually + updating the contact settings. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + contact_settings: 'ContactSettings' = proto.Field( + proto.MESSAGE, + number=2, + message='ContactSettings', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='ContactNotice', + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=5, + ) + + +class ExportRegistrationRequest(proto.Message): + r"""Request for the ``ExportRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to export, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteRegistrationRequest(proto.Message): + r"""Request for the ``DeleteRegistration`` method. + + Attributes: + name (str): + Required. The name of the ``Registration`` to delete, in the + format ``projects/*/locations/*/registrations/*``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class RetrieveAuthorizationCodeRequest(proto.Message): + r"""Request for the ``RetrieveAuthorizationCode`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being retrieved, in the format + ``projects/*/locations/*/registrations/*``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ResetAuthorizationCodeRequest(proto.Message): + r"""Request for the ``ResetAuthorizationCode`` method. + + Attributes: + registration (str): + Required. The name of the ``Registration`` whose + authorization code is being reset, in the format + ``projects/*/locations/*/registrations/*``. + """ + + registration: str = proto.Field( + proto.STRING, + number=1, + ) + + +class RegisterParameters(proto.Message): + r"""Parameters required to register a new domain. + + Attributes: + domain_name (str): + The domain name. Unicode domain names are + expressed in Punycode format. + availability (google.cloud.domains_v1beta1.types.RegisterParameters.Availability): + Indicates whether the domain is available for registration. + This value is accurate when obtained by calling + ``RetrieveRegisterParameters``, but is approximate when + obtained by calling ``SearchDomains``. + supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): + Contact privacy options that the domain + supports. + domain_notices (MutableSequence[google.cloud.domains_v1beta1.types.DomainNotice]): + Notices about special properties of the + domain. + yearly_price (google.type.money_pb2.Money): + Price to register or renew the domain for one + year. + """ + class Availability(proto.Enum): + r"""Possible availability states of a domain name. + + Values: + AVAILABILITY_UNSPECIFIED (0): + The availability is unspecified. + AVAILABLE (1): + The domain is available for registration. + UNAVAILABLE (2): + The domain is not available for registration. + Generally this means it is already registered to + another party. + UNSUPPORTED (3): + The domain is not currently supported by + Cloud Domains, but may be available elsewhere. + UNKNOWN (4): + Cloud Domains is unable to determine domain + availability, generally due to system + maintenance at the domain name registry. + """ + AVAILABILITY_UNSPECIFIED = 0 + AVAILABLE = 1 + UNAVAILABLE = 2 + UNSUPPORTED = 3 + UNKNOWN = 4 + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + availability: Availability = proto.Field( + proto.ENUM, + number=2, + enum=Availability, + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=3, + enum='ContactPrivacy', + ) + domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( + proto.ENUM, + number=4, + enum='DomainNotice', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=5, + message=money_pb2.Money, + ) + + +class TransferParameters(proto.Message): + r"""Parameters required to transfer a domain from another + registrar. + + Attributes: + domain_name (str): + The domain name. Unicode domain names are + expressed in Punycode format. + current_registrar (str): + The registrar that currently manages the + domain. + name_servers (MutableSequence[str]): + The name servers that currently store the + configuration of the domain. + transfer_lock_state (google.cloud.domains_v1beta1.types.TransferLockState): + Indicates whether the domain is protected by a transfer + lock. For a transfer to succeed, this must show + ``UNLOCKED``. To unlock a domain, go to its current + registrar. + supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): + Contact privacy options that the domain + supports. + yearly_price (google.type.money_pb2.Money): + Price to transfer or renew the domain for one + year. + """ + + domain_name: str = proto.Field( + proto.STRING, + number=1, + ) + current_registrar: str = proto.Field( + proto.STRING, + number=2, + ) + name_servers: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + transfer_lock_state: 'TransferLockState' = proto.Field( + proto.ENUM, + number=4, + enum='TransferLockState', + ) + supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( + proto.ENUM, + number=5, + enum='ContactPrivacy', + ) + yearly_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=6, + message=money_pb2.Money, + ) + + +class AuthorizationCode(proto.Message): + r"""Defines an authorization code. + + Attributes: + code (str): + The Authorization Code in ASCII. It can be + used to transfer the domain to or from another + registrar. + """ + + code: str = proto.Field( + proto.STRING, + number=1, + ) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of the long-running operation. Output + only. + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation finished running. + target (str): + Server-defined resource path for the target + of the operation. + verb (str): + Name of the verb executed by the operation. + status_detail (str): + Human-readable status of the operation, if + any. + api_version (str): + API version used to start the operation. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target: str = proto.Field( + proto.STRING, + number=3, + ) + verb: str = proto.Field( + proto.STRING, + number=4, + ) + status_detail: str = proto.Field( + proto.STRING, + number=5, + ) + api_version: str = proto.Field( + proto.STRING, + number=6, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/mypy.ini b/owl-bot-staging/v1beta1/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v1beta1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1beta1/noxfile.py b/owl-bot-staging/v1beta1/noxfile.py new file mode 100644 index 0000000..286feee --- /dev/null +++ b/owl-bot-staging/v1beta1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/domains_v1beta1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py new file mode 100644 index 0000000..bb0437b --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureContactSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureContactSettings_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 domains_v1beta1 + + +async def sample_configure_contact_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureContactSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py new file mode 100644 index 0000000..44fcfa8 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureContactSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureContactSettings_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 domains_v1beta1 + + +def sample_configure_contact_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureContactSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_contact_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureContactSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py new file mode 100644 index 0000000..8a3996f --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureDnsSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureDnsSettings_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 domains_v1beta1 + + +async def sample_configure_dns_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureDnsSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py new file mode 100644 index 0000000..bc602c6 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureDnsSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureDnsSettings_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 domains_v1beta1 + + +def sample_configure_dns_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureDnsSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_dns_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureDnsSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py new file mode 100644 index 0000000..58f01da --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureManagementSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureManagementSettings_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 domains_v1beta1 + + +async def sample_configure_management_settings(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureManagementSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py new file mode 100644 index 0000000..9ad8c8a --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ConfigureManagementSettings +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ConfigureManagementSettings_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 domains_v1beta1 + + +def sample_configure_management_settings(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ConfigureManagementSettingsRequest( + registration="registration_value", + ) + + # Make the request + operation = client.configure_management_settings(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ConfigureManagementSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py new file mode 100644 index 0000000..c1c7a42 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_DeleteRegistration_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 domains_v1beta1 + + +async def sample_delete_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_DeleteRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py new file mode 100644 index 0000000..7a63afc --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_DeleteRegistration_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 domains_v1beta1 + + +def sample_delete_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.DeleteRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_DeleteRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py new file mode 100644 index 0000000..72f9e71 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ExportRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ExportRegistration_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 domains_v1beta1 + + +async def sample_export_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ExportRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py new file mode 100644 index 0000000..1c501b0 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ExportRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ExportRegistration_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 domains_v1beta1 + + +def sample_export_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ExportRegistrationRequest( + name="name_value", + ) + + # Make the request + operation = client.export_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ExportRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py new file mode 100644 index 0000000..75c18bd --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_GetRegistration_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 domains_v1beta1 + + +async def sample_get_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_registration(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_GetRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py new file mode 100644 index 0000000..e92a14e --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_GetRegistration_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 domains_v1beta1 + + +def sample_get_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.GetRegistrationRequest( + name="name_value", + ) + + # Make the request + response = client.get_registration(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_GetRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py new file mode 100644 index 0000000..86667eb --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRegistrations +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ListRegistrations_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 domains_v1beta1 + + +async def sample_list_registrations(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END domains_v1beta1_generated_Domains_ListRegistrations_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py new file mode 100644 index 0000000..d16b07b --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRegistrations +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ListRegistrations_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 domains_v1beta1 + + +def sample_list_registrations(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ListRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END domains_v1beta1_generated_Domains_ListRegistrations_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py new file mode 100644 index 0000000..3c198ed --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDomain +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RegisterDomain_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 domains_v1beta1 + + +async def sample_register_domain(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RegisterDomain_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py new file mode 100644 index 0000000..f884730 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDomain +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RegisterDomain_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 domains_v1beta1 + + +def sample_register_domain(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.RegisterDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.register_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RegisterDomain_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py new file mode 100644 index 0000000..975b01d --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ResetAuthorizationCode +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ResetAuthorizationCode_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 domains_v1beta1 + + +async def sample_reset_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.reset_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ResetAuthorizationCode_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py new file mode 100644 index 0000000..27d4d98 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ResetAuthorizationCode +# 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-domains + + +# [START domains_v1beta1_generated_Domains_ResetAuthorizationCode_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 domains_v1beta1 + + +def sample_reset_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.ResetAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.reset_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_ResetAuthorizationCode_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py new file mode 100644 index 0000000..b34393e --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveAuthorizationCode +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1beta1 + + +async def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = await client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py new file mode 100644 index 0000000..f3c6a9d --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveAuthorizationCode +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1beta1 + + +def sample_retrieve_authorization_code(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveAuthorizationCodeRequest( + registration="registration_value", + ) + + # Make the request + response = client.retrieve_authorization_code(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py new file mode 100644 index 0000000..20cab05 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveRegisterParameters +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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 domains_v1beta1 + + +async def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveRegisterParameters_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py new file mode 100644 index 0000000..2a84363 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveRegisterParameters +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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 domains_v1beta1 + + +def sample_retrieve_register_parameters(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveRegisterParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_register_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveRegisterParameters_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py new file mode 100644 index 0000000..782911a --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveTransferParameters +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveTransferParameters_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 domains_v1beta1 + + +async def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = await client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveTransferParameters_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py new file mode 100644 index 0000000..47d7e44 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RetrieveTransferParameters +# 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-domains + + +# [START domains_v1beta1_generated_Domains_RetrieveTransferParameters_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 domains_v1beta1 + + +def sample_retrieve_transfer_parameters(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.RetrieveTransferParametersRequest( + domain_name="domain_name_value", + location="location_value", + ) + + # Make the request + response = client.retrieve_transfer_parameters(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_RetrieveTransferParameters_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py new file mode 100644 index 0000000..13021af --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchDomains +# 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-domains + + +# [START domains_v1beta1_generated_Domains_SearchDomains_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 domains_v1beta1 + + +async def sample_search_domains(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = await client.search_domains(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_SearchDomains_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py new file mode 100644 index 0000000..bbaa28a --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchDomains +# 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-domains + + +# [START domains_v1beta1_generated_Domains_SearchDomains_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 domains_v1beta1 + + +def sample_search_domains(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.SearchDomainsRequest( + query="query_value", + location="location_value", + ) + + # Make the request + response = client.search_domains(request=request) + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_SearchDomains_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py new file mode 100644 index 0000000..f63c76c --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TransferDomain +# 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-domains + + +# [START domains_v1beta1_generated_Domains_TransferDomain_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 domains_v1beta1 + + +async def sample_transfer_domain(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_TransferDomain_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py new file mode 100644 index 0000000..d406add --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TransferDomain +# 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-domains + + +# [START domains_v1beta1_generated_Domains_TransferDomain_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 domains_v1beta1 + + +def sample_transfer_domain(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + registration = domains_v1beta1.Registration() + registration.domain_name = "domain_name_value" + registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" + registration.contact_settings.registrant_contact.email = "email_value" + registration.contact_settings.registrant_contact.phone_number = "phone_number_value" + registration.contact_settings.admin_contact.email = "email_value" + registration.contact_settings.admin_contact.phone_number = "phone_number_value" + registration.contact_settings.technical_contact.email = "email_value" + registration.contact_settings.technical_contact.phone_number = "phone_number_value" + + request = domains_v1beta1.TransferDomainRequest( + parent="parent_value", + registration=registration, + ) + + # Make the request + operation = client.transfer_domain(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_TransferDomain_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py new file mode 100644 index 0000000..2808bff --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_UpdateRegistration_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 domains_v1beta1 + + +async def sample_update_registration(): + # Create a client + client = domains_v1beta1.DomainsAsyncClient() + + # Initialize request argument(s) + request = domains_v1beta1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_UpdateRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py new file mode 100644 index 0000000..28f8559 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRegistration +# 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-domains + + +# [START domains_v1beta1_generated_Domains_UpdateRegistration_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 domains_v1beta1 + + +def sample_update_registration(): + # Create a client + client = domains_v1beta1.DomainsClient() + + # Initialize request argument(s) + request = domains_v1beta1.UpdateRegistrationRequest( + ) + + # Make the request + operation = client.update_registration(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END domains_v1beta1_generated_Domains_UpdateRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json b/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json new file mode 100644 index 0000000..7634af9 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json @@ -0,0 +1,2550 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.domains.v1beta1", + "version": "v1beta1" + } + ], + "language": "PYTHON", + "name": "google-cloud-domains", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_contact_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureContactSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureContactSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "contact_settings", + "type": "google.cloud.domains_v1beta1.types.ContactSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_contact_settings" + }, + "description": "Sample for ConfigureContactSettings", + "file": "domains_v1beta1_generated_domains_configure_contact_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureContactSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_contact_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_contact_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureContactSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureContactSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "contact_settings", + "type": "google.cloud.domains_v1beta1.types.ContactSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_contact_settings" + }, + "description": "Sample for ConfigureContactSettings", + "file": "domains_v1beta1_generated_domains_configure_contact_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureContactSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_contact_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_dns_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureDnsSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureDnsSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "dns_settings", + "type": "google.cloud.domains_v1beta1.types.DnsSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_dns_settings" + }, + "description": "Sample for ConfigureDnsSettings", + "file": "domains_v1beta1_generated_domains_configure_dns_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureDnsSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_dns_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_dns_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureDnsSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureDnsSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "dns_settings", + "type": "google.cloud.domains_v1beta1.types.DnsSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_dns_settings" + }, + "description": "Sample for ConfigureDnsSettings", + "file": "domains_v1beta1_generated_domains_configure_dns_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureDnsSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_dns_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_management_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureManagementSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureManagementSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "management_settings", + "type": "google.cloud.domains_v1beta1.types.ManagementSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "configure_management_settings" + }, + "description": "Sample for ConfigureManagementSettings", + "file": "domains_v1beta1_generated_domains_configure_management_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureManagementSettings_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_management_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_management_settings", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureManagementSettings", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ConfigureManagementSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "management_settings", + "type": "google.cloud.domains_v1beta1.types.ManagementSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "configure_management_settings" + }, + "description": "Sample for ConfigureManagementSettings", + "file": "domains_v1beta1_generated_domains_configure_management_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ConfigureManagementSettings_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_configure_management_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.delete_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.DeleteRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "DeleteRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.DeleteRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_registration" + }, + "description": "Sample for DeleteRegistration", + "file": "domains_v1beta1_generated_domains_delete_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_DeleteRegistration_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_delete_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.delete_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.DeleteRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "DeleteRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.DeleteRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_registration" + }, + "description": "Sample for DeleteRegistration", + "file": "domains_v1beta1_generated_domains_delete_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_DeleteRegistration_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_delete_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.export_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ExportRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ExportRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ExportRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "export_registration" + }, + "description": "Sample for ExportRegistration", + "file": "domains_v1beta1_generated_domains_export_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ExportRegistration_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_export_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.export_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ExportRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ExportRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ExportRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "export_registration" + }, + "description": "Sample for ExportRegistration", + "file": "domains_v1beta1_generated_domains_export_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ExportRegistration_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_export_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.get_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.GetRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "GetRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.GetRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.Registration", + "shortName": "get_registration" + }, + "description": "Sample for GetRegistration", + "file": "domains_v1beta1_generated_domains_get_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_GetRegistration_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": "domains_v1beta1_generated_domains_get_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.get_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.GetRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "GetRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.GetRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.Registration", + "shortName": "get_registration" + }, + "description": "Sample for GetRegistration", + "file": "domains_v1beta1_generated_domains_get_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_GetRegistration_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": "domains_v1beta1_generated_domains_get_registration_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.list_registrations", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ListRegistrations", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ListRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ListRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager", + "shortName": "list_registrations" + }, + "description": "Sample for ListRegistrations", + "file": "domains_v1beta1_generated_domains_list_registrations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ListRegistrations_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": "domains_v1beta1_generated_domains_list_registrations_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.list_registrations", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ListRegistrations", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ListRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ListRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager", + "shortName": "list_registrations" + }, + "description": "Sample for ListRegistrations", + "file": "domains_v1beta1_generated_domains_list_registrations_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ListRegistrations_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": "domains_v1beta1_generated_domains_list_registrations_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.register_domain", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RegisterDomain", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RegisterDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RegisterDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "register_domain" + }, + "description": "Sample for RegisterDomain", + "file": "domains_v1beta1_generated_domains_register_domain_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RegisterDomain_async", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_register_domain_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.register_domain", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RegisterDomain", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RegisterDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RegisterDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "register_domain" + }, + "description": "Sample for RegisterDomain", + "file": "domains_v1beta1_generated_domains_register_domain_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RegisterDomain_sync", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_register_domain_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.reset_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ResetAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ResetAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", + "shortName": "reset_authorization_code" + }, + "description": "Sample for ResetAuthorizationCode", + "file": "domains_v1beta1_generated_domains_reset_authorization_code_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ResetAuthorizationCode_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": "domains_v1beta1_generated_domains_reset_authorization_code_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.reset_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.ResetAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "ResetAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", + "shortName": "reset_authorization_code" + }, + "description": "Sample for ResetAuthorizationCode", + "file": "domains_v1beta1_generated_domains_reset_authorization_code_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_ResetAuthorizationCode_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": "domains_v1beta1_generated_domains_reset_authorization_code_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", + "shortName": "retrieve_authorization_code" + }, + "description": "Sample for RetrieveAuthorizationCode", + "file": "domains_v1beta1_generated_domains_retrieve_authorization_code_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1beta1_generated_domains_retrieve_authorization_code_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_authorization_code", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveAuthorizationCode", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveAuthorizationCode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest" + }, + { + "name": "registration", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", + "shortName": "retrieve_authorization_code" + }, + "description": "Sample for RetrieveAuthorizationCode", + "file": "domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_register_parameters", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveRegisterParameters", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveRegisterParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse", + "shortName": "retrieve_register_parameters" + }, + "description": "Sample for RetrieveRegisterParameters", + "file": "domains_v1beta1_generated_domains_retrieve_register_parameters_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1beta1_generated_domains_retrieve_register_parameters_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_register_parameters", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveRegisterParameters", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveRegisterParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse", + "shortName": "retrieve_register_parameters" + }, + "description": "Sample for RetrieveRegisterParameters", + "file": "domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_transfer_parameters", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveTransferParameters", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveTransferParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse", + "shortName": "retrieve_transfer_parameters" + }, + "description": "Sample for RetrieveTransferParameters", + "file": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveTransferParameters_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": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_transfer_parameters", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveTransferParameters", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "RetrieveTransferParameters" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "domain_name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse", + "shortName": "retrieve_transfer_parameters" + }, + "description": "Sample for RetrieveTransferParameters", + "file": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_RetrieveTransferParameters_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": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.search_domains", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.SearchDomains", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "SearchDomains" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.SearchDomainsRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.SearchDomainsResponse", + "shortName": "search_domains" + }, + "description": "Sample for SearchDomains", + "file": "domains_v1beta1_generated_domains_search_domains_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_SearchDomains_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": "domains_v1beta1_generated_domains_search_domains_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.search_domains", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.SearchDomains", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "SearchDomains" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.SearchDomainsRequest" + }, + { + "name": "location", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.domains_v1beta1.types.SearchDomainsResponse", + "shortName": "search_domains" + }, + "description": "Sample for SearchDomains", + "file": "domains_v1beta1_generated_domains_search_domains_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_SearchDomains_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": "domains_v1beta1_generated_domains_search_domains_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.transfer_domain", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.TransferDomain", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "TransferDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.TransferDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "authorization_code", + "type": "google.cloud.domains_v1beta1.types.AuthorizationCode" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "transfer_domain" + }, + "description": "Sample for TransferDomain", + "file": "domains_v1beta1_generated_domains_transfer_domain_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_TransferDomain_async", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_transfer_domain_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.transfer_domain", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.TransferDomain", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "TransferDomain" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.TransferDomainRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "yearly_price", + "type": "google.type.money_pb2.Money" + }, + { + "name": "authorization_code", + "type": "google.cloud.domains_v1beta1.types.AuthorizationCode" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "transfer_domain" + }, + "description": "Sample for TransferDomain", + "file": "domains_v1beta1_generated_domains_transfer_domain_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_TransferDomain_sync", + "segments": [ + { + "end": 66, + "start": 27, + "type": "FULL" + }, + { + "end": 66, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 63, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 67, + "start": 64, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_transfer_domain_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", + "shortName": "DomainsAsyncClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.update_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.UpdateRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "UpdateRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.UpdateRegistrationRequest" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_registration" + }, + "description": "Sample for UpdateRegistration", + "file": "domains_v1beta1_generated_domains_update_registration_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_UpdateRegistration_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_update_registration_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.domains_v1beta1.DomainsClient", + "shortName": "DomainsClient" + }, + "fullName": "google.cloud.domains_v1beta1.DomainsClient.update_registration", + "method": { + "fullName": "google.cloud.domains.v1beta1.Domains.UpdateRegistration", + "service": { + "fullName": "google.cloud.domains.v1beta1.Domains", + "shortName": "Domains" + }, + "shortName": "UpdateRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.domains_v1beta1.types.UpdateRegistrationRequest" + }, + { + "name": "registration", + "type": "google.cloud.domains_v1beta1.types.Registration" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_registration" + }, + "description": "Sample for UpdateRegistration", + "file": "domains_v1beta1_generated_domains_update_registration_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "domains_v1beta1_generated_Domains_UpdateRegistration_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "domains_v1beta1_generated_domains_update_registration_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py b/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py new file mode 100644 index 0000000..39c812d --- /dev/null +++ b/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py @@ -0,0 +1,190 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class domainsCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'configure_contact_settings': ('registration', 'update_mask', 'contact_settings', 'contact_notices', 'validate_only', ), + 'configure_dns_settings': ('registration', 'update_mask', 'dns_settings', 'validate_only', ), + 'configure_management_settings': ('registration', 'update_mask', 'management_settings', ), + 'delete_registration': ('name', ), + 'export_registration': ('name', ), + 'get_registration': ('name', ), + 'list_registrations': ('parent', 'page_size', 'page_token', 'filter', ), + 'register_domain': ('parent', 'registration', 'yearly_price', 'domain_notices', 'contact_notices', 'validate_only', ), + 'reset_authorization_code': ('registration', ), + 'retrieve_authorization_code': ('registration', ), + 'retrieve_register_parameters': ('domain_name', 'location', ), + 'retrieve_transfer_parameters': ('domain_name', 'location', ), + 'search_domains': ('query', 'location', ), + 'transfer_domain': ('parent', 'registration', 'yearly_price', 'contact_notices', 'authorization_code', 'validate_only', ), + 'update_registration': ('update_mask', 'registration', ), + } + + 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=domainsCallTransformer(), +): + """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 domains 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/v1beta1/setup.py b/owl-bot-staging/v1beta1/setup.py new file mode 100644 index 0000000..70be905 --- /dev/null +++ b/owl-bot-staging/v1beta1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-domains' + + +description = "Google Cloud Domains API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/domains/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-domains" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.10.txt b/owl-bot-staging/v1beta1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.11.txt b/owl-bot-staging/v1beta1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.12.txt b/owl-bot-staging/v1beta1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.7.txt b/owl-bot-staging/v1beta1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.8.txt b/owl-bot-staging/v1beta1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.9.txt b/owl-bot-staging/v1beta1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/tests/__init__.py b/owl-bot-staging/v1beta1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/__init__.py b/owl-bot-staging/v1beta1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py new file mode 100644 index 0000000..9063619 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py @@ -0,0 +1,8728 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.domains_v1beta1.services.domains import DomainsAsyncClient +from google.cloud.domains_v1beta1.services.domains import DomainsClient +from google.cloud.domains_v1beta1.services.domains import pagers +from google.cloud.domains_v1beta1.services.domains import transports +from google.cloud.domains_v1beta1.types import domains +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore +from google.type import postal_address_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert DomainsClient._get_default_mtls_endpoint(None) is None + assert DomainsClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert DomainsClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (DomainsClient, "grpc"), + (DomainsAsyncClient, "grpc_asyncio"), + (DomainsClient, "rest"), +]) +def test_domains_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 == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://domains.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.DomainsGrpcTransport, "grpc"), + (transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.DomainsRestTransport, "rest"), +]) +def test_domains_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", [ + (DomainsClient, "grpc"), + (DomainsAsyncClient, "grpc_asyncio"), + (DomainsClient, "rest"), +]) +def test_domains_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 == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://domains.googleapis.com' + ) + + +def test_domains_client_get_transport_class(): + transport = DomainsClient.get_transport_class() + available_transports = [ + transports.DomainsGrpcTransport, + transports.DomainsRestTransport, + ] + assert transport in available_transports + + transport = DomainsClient.get_transport_class("grpc") + assert transport == transports.DomainsGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (DomainsClient, transports.DomainsRestTransport, "rest"), +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +def test_domains_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(DomainsClient, '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(DomainsClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", "true"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (DomainsClient, transports.DomainsGrpcTransport, "grpc", "false"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (DomainsClient, transports.DomainsRestTransport, "rest", "true"), + (DomainsClient, transports.DomainsRestTransport, "rest", "false"), +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_domains_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + DomainsClient, DomainsAsyncClient +]) +@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) +@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) +def test_domains_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc"), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), + (DomainsClient, transports.DomainsRestTransport, "rest"), +]) +def test_domains_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (DomainsClient, transports.DomainsRestTransport, "rest", None), +]) +def test_domains_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_domains_client_client_options_from_dict(): + with mock.patch('google.cloud.domains_v1beta1.services.domains.transports.DomainsGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = DomainsClient( + 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", [ + (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_domains_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "domains.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="domains.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + domains.SearchDomainsRequest, + dict, +]) +def test_search_domains(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse( + ) + response = client.search_domains(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +def test_search_domains_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + client.search_domains() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + +@pytest.mark.asyncio +async def test_search_domains_async(transport: str = 'grpc_asyncio', request_type=domains.SearchDomainsRequest): + client = DomainsAsyncClient( + 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_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse( + )) + response = await client.search_domains(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.SearchDomainsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +@pytest.mark.asyncio +async def test_search_domains_async_from_dict(): + await test_search_domains_async(request_type=dict) + + +def test_search_domains_field_headers(): + client = DomainsClient( + 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 = domains.SearchDomainsRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + call.return_value = domains.SearchDomainsResponse() + client.search_domains(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_domains_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.SearchDomainsRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) + await client.search_domains(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_search_domains_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_domains( + location='location_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + + +def test_search_domains_flattened_error(): + client = DomainsClient( + 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_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + +@pytest.mark.asyncio +async def test_search_domains_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_domains), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.SearchDomainsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_domains( + location='location_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_search_domains_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveRegisterParametersRequest, + dict, +]) +def test_retrieve_register_parameters(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse( + ) + response = client.retrieve_register_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +def test_retrieve_register_parameters_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + client.retrieve_register_parameters() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveRegisterParametersRequest): + client = DomainsAsyncClient( + 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.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse( + )) + response = await client.retrieve_register_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveRegisterParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_async_from_dict(): + await test_retrieve_register_parameters_async(request_type=dict) + + +def test_retrieve_register_parameters_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveRegisterParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + call.return_value = domains.RetrieveRegisterParametersResponse() + client.retrieve_register_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveRegisterParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) + await client.retrieve_register_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_retrieve_register_parameters_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_register_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + + +def test_retrieve_register_parameters_flattened_error(): + client = DomainsClient( + 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.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_register_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveRegisterParametersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_register_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_register_parameters_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RegisterDomainRequest, + dict, +]) +def test_register_domain(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.register_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_register_domain_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + client.register_domain() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + +@pytest.mark.asyncio +async def test_register_domain_async(transport: str = 'grpc_asyncio', request_type=domains.RegisterDomainRequest): + client = DomainsAsyncClient( + 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.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.register_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RegisterDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_register_domain_async_from_dict(): + await test_register_domain_async(request_type=dict) + + +def test_register_domain_field_headers(): + client = DomainsClient( + 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 = domains.RegisterDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.register_domain(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_register_domain_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RegisterDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.register_domain(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_register_domain_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.register_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + + +def test_register_domain_flattened_error(): + client = DomainsClient( + 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.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + +@pytest.mark.asyncio +async def test_register_domain_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.register_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_register_domain_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveTransferParametersRequest, + dict, +]) +def test_retrieve_transfer_parameters(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse( + ) + response = client.retrieve_transfer_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +def test_retrieve_transfer_parameters_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + client.retrieve_transfer_parameters() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveTransferParametersRequest): + client = DomainsAsyncClient( + 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.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse( + )) + response = await client.retrieve_transfer_parameters(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveTransferParametersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_async_from_dict(): + await test_retrieve_transfer_parameters_async(request_type=dict) + + +def test_retrieve_transfer_parameters_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveTransferParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + call.return_value = domains.RetrieveTransferParametersResponse() + client.retrieve_transfer_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveTransferParametersRequest() + + request.location = 'location_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) + await client.retrieve_transfer_parameters(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', + 'location=location_value', + ) in kw['metadata'] + + +def test_retrieve_transfer_parameters_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_transfer_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + + +def test_retrieve_transfer_parameters_flattened_error(): + client = DomainsClient( + 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.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_transfer_parameters), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.RetrieveTransferParametersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_transfer_parameters( + location='location_value', + domain_name='domain_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].location + mock_val = 'location_value' + assert arg == mock_val + arg = args[0].domain_name + mock_val = 'domain_name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_transfer_parameters_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.TransferDomainRequest, + dict, +]) +def test_transfer_domain(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.transfer_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_transfer_domain_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + client.transfer_domain() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + +@pytest.mark.asyncio +async def test_transfer_domain_async(transport: str = 'grpc_asyncio', request_type=domains.TransferDomainRequest): + client = DomainsAsyncClient( + 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.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.transfer_domain(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.TransferDomainRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_transfer_domain_async_from_dict(): + await test_transfer_domain_async(request_type=dict) + + +def test_transfer_domain_field_headers(): + client = DomainsClient( + 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 = domains.TransferDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.transfer_domain(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_transfer_domain_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.TransferDomainRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.transfer_domain(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_transfer_domain_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.transfer_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + arg = args[0].authorization_code + mock_val = domains.AuthorizationCode(code='code_value') + assert arg == mock_val + + +def test_transfer_domain_flattened_error(): + client = DomainsClient( + 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.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + +@pytest.mark.asyncio +async def test_transfer_domain_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.transfer_domain), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.transfer_domain( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_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].registration + mock_val = domains.Registration(name='name_value') + assert arg == mock_val + arg = args[0].yearly_price + mock_val = money_pb2.Money(currency_code='currency_code_value') + assert arg == mock_val + arg = args[0].authorization_code + mock_val = domains.AuthorizationCode(code='code_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_transfer_domain_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ListRegistrationsRequest, + dict, +]) +def test_list_registrations(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_registrations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_registrations_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + client.list_registrations() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + +@pytest.mark.asyncio +async def test_list_registrations_async(transport: str = 'grpc_asyncio', request_type=domains.ListRegistrationsRequest): + client = DomainsAsyncClient( + 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_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_registrations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ListRegistrationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_registrations_async_from_dict(): + await test_list_registrations_async(request_type=dict) + + +def test_list_registrations_field_headers(): + client = DomainsClient( + 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 = domains.ListRegistrationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + call.return_value = domains.ListRegistrationsResponse() + client.list_registrations(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_registrations_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ListRegistrationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) + await client.list_registrations(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_registrations_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_registrations( + 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_registrations_flattened_error(): + client = DomainsClient( + 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_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_registrations_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.ListRegistrationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_registrations( + 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_registrations_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + + +def test_list_registrations_pager(transport_name: str = "grpc"): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_registrations(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, domains.Registration) + for i in results) +def test_list_registrations_pages(transport_name: str = "grpc"): + client = DomainsClient( + 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_registrations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + pages = list(client.list_registrations(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_registrations_async_pager(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_registrations(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, domains.Registration) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_registrations_async_pages(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_registrations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_registrations(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + domains.GetRegistrationRequest, + dict, +]) +def test_get_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + ) + response = client.get_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +def test_get_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + client.get_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + +@pytest.mark.asyncio +async def test_get_registration_async(transport: str = 'grpc_asyncio', request_type=domains.GetRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + )) + response = await client.get_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.GetRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +@pytest.mark.asyncio +async def test_get_registration_async_from_dict(): + await test_get_registration_async(request_type=dict) + + +def test_get_registration_field_headers(): + client = DomainsClient( + 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 = domains.GetRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + call.return_value = domains.Registration() + client.get_registration(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_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.GetRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) + await client.get_registration(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_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_registration( + 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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.Registration() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_registration( + 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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.UpdateRegistrationRequest, + dict, +]) +def test_update_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + client.update_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + +@pytest.mark.asyncio +async def test_update_registration_async(transport: str = 'grpc_asyncio', request_type=domains.UpdateRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.UpdateRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_registration_async_from_dict(): + await test_update_registration_async(request_type=dict) + + +def test_update_registration_field_headers(): + client = DomainsClient( + 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 = domains.UpdateRegistrationRequest() + + request.registration.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_registration(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', + 'registration.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.UpdateRegistrationRequest() + + request.registration.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_registration(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', + 'registration.name=name_value', + ) in kw['metadata'] + + +def test_update_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_registration( + registration=domains.Registration(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].registration + mock_val = domains.Registration(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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_registration( + registration=domains.Registration(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].registration + mock_val = domains.Registration(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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureManagementSettingsRequest, + dict, +]) +def test_configure_management_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_management_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_management_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + client.configure_management_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_management_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureManagementSettingsRequest): + client = DomainsAsyncClient( + 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.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_management_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureManagementSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_management_settings_async_from_dict(): + await test_configure_management_settings_async(request_type=dict) + + +def test_configure_management_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureManagementSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_management_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_management_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureManagementSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_management_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_management_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_management_settings( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].management_settings + mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_configure_management_settings_flattened_error(): + client = DomainsClient( + 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.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_management_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_management_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_management_settings( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].management_settings + mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) + 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_configure_management_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureDnsSettingsRequest, + dict, +]) +def test_configure_dns_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_dns_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_dns_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + client.configure_dns_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_dns_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureDnsSettingsRequest): + client = DomainsAsyncClient( + 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.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_dns_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureDnsSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_dns_settings_async_from_dict(): + await test_configure_dns_settings_async(request_type=dict) + + +def test_configure_dns_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureDnsSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_dns_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_dns_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureDnsSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_dns_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_dns_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_dns_settings( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].dns_settings + mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error(): + client = DomainsClient( + 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.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_dns_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_dns_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_dns_settings( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].dns_settings + mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureContactSettingsRequest, + dict, +]) +def test_configure_contact_settings(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.configure_contact_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_configure_contact_settings_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + client.configure_contact_settings() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + +@pytest.mark.asyncio +async def test_configure_contact_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureContactSettingsRequest): + client = DomainsAsyncClient( + 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.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.configure_contact_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ConfigureContactSettingsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_configure_contact_settings_async_from_dict(): + await test_configure_contact_settings_async(request_type=dict) + + +def test_configure_contact_settings_field_headers(): + client = DomainsClient( + 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 = domains.ConfigureContactSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.configure_contact_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_configure_contact_settings_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ConfigureContactSettingsRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.configure_contact_settings(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_configure_contact_settings_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.configure_contact_settings( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].contact_settings + mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_configure_contact_settings_flattened_error(): + client = DomainsClient( + 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.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_configure_contact_settings_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.configure_contact_settings), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.configure_contact_settings( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + 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].registration + mock_val = 'registration_value' + assert arg == mock_val + arg = args[0].contact_settings + mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) + 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_configure_contact_settings_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ExportRegistrationRequest, + dict, +]) +def test_export_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.export_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_export_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + client.export_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + +@pytest.mark.asyncio +async def test_export_registration_async(transport: str = 'grpc_asyncio', request_type=domains.ExportRegistrationRequest): + client = DomainsAsyncClient( + 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.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.export_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ExportRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_export_registration_async_from_dict(): + await test_export_registration_async(request_type=dict) + + +def test_export_registration_field_headers(): + client = DomainsClient( + 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 = domains.ExportRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.export_registration(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_export_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ExportRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.export_registration(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_export_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.export_registration( + 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_export_registration_flattened_error(): + client = DomainsClient( + 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.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_export_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.export_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.export_registration( + 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_export_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.DeleteRegistrationRequest, + dict, +]) +def test_delete_registration(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_registration_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + client.delete_registration() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + +@pytest.mark.asyncio +async def test_delete_registration_async(transport: str = 'grpc_asyncio', request_type=domains.DeleteRegistrationRequest): + client = DomainsAsyncClient( + 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_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_registration(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.DeleteRegistrationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_registration_async_from_dict(): + await test_delete_registration_async(request_type=dict) + + +def test_delete_registration_field_headers(): + client = DomainsClient( + 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 = domains.DeleteRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_registration(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_registration_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.DeleteRegistrationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_registration(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_registration_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_registration( + 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_registration_flattened_error(): + client = DomainsClient( + 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_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_registration_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_registration), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_registration( + 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_registration_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveAuthorizationCodeRequest, + dict, +]) +def test_retrieve_authorization_code(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode( + code='code_value', + ) + response = client.retrieve_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_retrieve_authorization_code_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + client.retrieve_authorization_code() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveAuthorizationCodeRequest): + client = DomainsAsyncClient( + 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.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( + code='code_value', + )) + response = await client.retrieve_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.RetrieveAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_async_from_dict(): + await test_retrieve_authorization_code_async(request_type=dict) + + +def test_retrieve_authorization_code_field_headers(): + client = DomainsClient( + 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 = domains.RetrieveAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + call.return_value = domains.AuthorizationCode() + client.retrieve_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.RetrieveAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + await client.retrieve_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_retrieve_authorization_code_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + + +def test_retrieve_authorization_code_flattened_error(): + client = DomainsClient( + 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.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_authorization_code_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ResetAuthorizationCodeRequest, + dict, +]) +def test_reset_authorization_code(request_type, transport: str = 'grpc'): + client = DomainsClient( + 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.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode( + code='code_value', + ) + response = client.reset_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_reset_authorization_code_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + client.reset_authorization_code() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + +@pytest.mark.asyncio +async def test_reset_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.ResetAuthorizationCodeRequest): + client = DomainsAsyncClient( + 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.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( + code='code_value', + )) + response = await client.reset_authorization_code(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == domains.ResetAuthorizationCodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +@pytest.mark.asyncio +async def test_reset_authorization_code_async_from_dict(): + await test_reset_authorization_code_async(request_type=dict) + + +def test_reset_authorization_code_field_headers(): + client = DomainsClient( + 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 = domains.ResetAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + call.return_value = domains.AuthorizationCode() + client.reset_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_reset_authorization_code_field_headers_async(): + client = DomainsAsyncClient( + 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 = domains.ResetAuthorizationCodeRequest() + + request.registration = 'registration_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + await client.reset_authorization_code(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', + 'registration=registration_value', + ) in kw['metadata'] + + +def test_reset_authorization_code_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.reset_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + + +def test_reset_authorization_code_flattened_error(): + client = DomainsClient( + 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.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + +@pytest.mark.asyncio +async def test_reset_authorization_code_flattened_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reset_authorization_code), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = domains.AuthorizationCode() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.reset_authorization_code( + registration='registration_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].registration + mock_val = 'registration_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_reset_authorization_code_flattened_error_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + + +@pytest.mark.parametrize("request_type", [ + domains.SearchDomainsRequest, + dict, +]) +def test_search_domains_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.SearchDomainsResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.search_domains(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.SearchDomainsResponse) + + +def test_search_domains_rest_required_fields(request_type=domains.SearchDomainsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["query"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "query" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "query" in jsonified_request + assert jsonified_request["query"] == request_init["query"] + + jsonified_request["query"] = 'query_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("query", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "query" in jsonified_request + assert jsonified_request["query"] == 'query_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.SearchDomainsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.search_domains(request) + + expected_params = [ + ( + "query", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_domains_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_domains._get_unset_required_fields({}) + assert set(unset_fields) == (set(("query", )) & set(("query", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_domains_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_search_domains") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_search_domains") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.SearchDomainsRequest.pb(domains.SearchDomainsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.SearchDomainsResponse.to_json(domains.SearchDomainsResponse()) + + request = domains.SearchDomainsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.SearchDomainsResponse() + + client.search_domains(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_domains_rest_bad_request(transport: str = 'rest', request_type=domains.SearchDomainsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_domains(request) + + +def test_search_domains_rest_flattened(): + client = DomainsClient( + 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 = domains.SearchDomainsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_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 + pb_return_value = domains.SearchDomainsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.search_domains(**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/v1beta1/{location=projects/*/locations/*}/registrations:searchDomains" % client.transport._host, args[1]) + + +def test_search_domains_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_domains( + domains.SearchDomainsRequest(), + location='location_value', + query='query_value', + ) + + +def test_search_domains_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveRegisterParametersRequest, + dict, +]) +def test_retrieve_register_parameters_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.RetrieveRegisterParametersResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_register_parameters(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveRegisterParametersResponse) + + +def test_retrieve_register_parameters_rest_required_fields(request_type=domains.RetrieveRegisterParametersRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["domain_name"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "domainName" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == request_init["domain_name"] + + jsonified_request["domainName"] = 'domain_name_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("domain_name", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == 'domain_name_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.RetrieveRegisterParametersResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_register_parameters(request) + + expected_params = [ + ( + "domainName", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_register_parameters_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_register_parameters._get_unset_required_fields({}) + assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_register_parameters_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_register_parameters") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_register_parameters") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveRegisterParametersRequest.pb(domains.RetrieveRegisterParametersRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.RetrieveRegisterParametersResponse.to_json(domains.RetrieveRegisterParametersResponse()) + + request = domains.RetrieveRegisterParametersRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.RetrieveRegisterParametersResponse() + + client.retrieve_register_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_register_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveRegisterParametersRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_register_parameters(request) + + +def test_retrieve_register_parameters_rest_flattened(): + client = DomainsClient( + 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 = domains.RetrieveRegisterParametersResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_value', + domain_name='domain_name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_register_parameters(**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/v1beta1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters" % client.transport._host, args[1]) + + +def test_retrieve_register_parameters_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_register_parameters( + domains.RetrieveRegisterParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +def test_retrieve_register_parameters_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RegisterDomainRequest, + dict, +]) +def test_register_domain_rest(request_type): + client = DomainsClient( + 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 = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_domain(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_register_domain_rest_required_fields(request_type=domains.RegisterDomainRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_domain._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()).register_domain._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_domain(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_domain_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_domain._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_domain_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_register_domain") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_register_domain") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RegisterDomainRequest.pb(domains.RegisterDomainRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.RegisterDomainRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.register_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_domain_rest_bad_request(transport: str = 'rest', request_type=domains.RegisterDomainRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_domain(request) + + +def test_register_domain_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_domain(**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/v1beta1/{parent=projects/*/locations/*}/registrations:register" % client.transport._host, args[1]) + + +def test_register_domain_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.register_domain( + domains.RegisterDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + ) + + +def test_register_domain_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveTransferParametersRequest, + dict, +]) +def test_retrieve_transfer_parameters_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'location': '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 = domains.RetrieveTransferParametersResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_transfer_parameters(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.RetrieveTransferParametersResponse) + + +def test_retrieve_transfer_parameters_rest_required_fields(request_type=domains.RetrieveTransferParametersRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["domain_name"] = "" + request_init["location"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "domainName" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == request_init["domain_name"] + + jsonified_request["domainName"] = 'domain_name_value' + jsonified_request["location"] = 'location_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("domain_name", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "domainName" in jsonified_request + assert jsonified_request["domainName"] == 'domain_name_value' + assert "location" in jsonified_request + assert jsonified_request["location"] == 'location_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.RetrieveTransferParametersResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_transfer_parameters(request) + + expected_params = [ + ( + "domainName", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_transfer_parameters_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_transfer_parameters._get_unset_required_fields({}) + assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_transfer_parameters_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_transfer_parameters") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_transfer_parameters") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveTransferParametersRequest.pb(domains.RetrieveTransferParametersRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.RetrieveTransferParametersResponse.to_json(domains.RetrieveTransferParametersResponse()) + + request = domains.RetrieveTransferParametersRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.RetrieveTransferParametersResponse() + + client.retrieve_transfer_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_transfer_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveTransferParametersRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'location': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_transfer_parameters(request) + + +def test_retrieve_transfer_parameters_rest_flattened(): + client = DomainsClient( + 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 = domains.RetrieveTransferParametersResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'location': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + location='location_value', + domain_name='domain_name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_transfer_parameters(**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/v1beta1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters" % client.transport._host, args[1]) + + +def test_retrieve_transfer_parameters_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_transfer_parameters( + domains.RetrieveTransferParametersRequest(), + location='location_value', + domain_name='domain_name_value', + ) + + +def test_retrieve_transfer_parameters_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.TransferDomainRequest, + dict, +]) +def test_transfer_domain_rest(request_type): + client = DomainsClient( + 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 = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.transfer_domain(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_transfer_domain_rest_required_fields(request_type=domains.TransferDomainRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).transfer_domain._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()).transfer_domain._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.transfer_domain(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_transfer_domain_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.transfer_domain._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_transfer_domain_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_transfer_domain") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_transfer_domain") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.TransferDomainRequest.pb(domains.TransferDomainRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.TransferDomainRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.transfer_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_transfer_domain_rest_bad_request(transport: str = 'rest', request_type=domains.TransferDomainRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.transfer_domain(request) + + +def test_transfer_domain_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.transfer_domain(**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/v1beta1/{parent=projects/*/locations/*}/registrations:transfer" % client.transport._host, args[1]) + + +def test_transfer_domain_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.transfer_domain( + domains.TransferDomainRequest(), + parent='parent_value', + registration=domains.Registration(name='name_value'), + yearly_price=money_pb2.Money(currency_code='currency_code_value'), + authorization_code=domains.AuthorizationCode(code='code_value'), + ) + + +def test_transfer_domain_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ListRegistrationsRequest, + dict, +]) +def test_list_registrations_rest(request_type): + client = DomainsClient( + 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 = domains.ListRegistrationsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_registrations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRegistrationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_registrations_rest_required_fields(request_type=domains.ListRegistrationsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_registrations._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_registrations._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("filter", "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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.ListRegistrationsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_registrations(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_registrations_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_registrations._get_unset_required_fields({}) + assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_registrations_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_list_registrations") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_list_registrations") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ListRegistrationsRequest.pb(domains.ListRegistrationsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.ListRegistrationsResponse.to_json(domains.ListRegistrationsResponse()) + + request = domains.ListRegistrationsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.ListRegistrationsResponse() + + client.list_registrations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_registrations_rest_bad_request(transport: str = 'rest', request_type=domains.ListRegistrationsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_registrations(request) + + +def test_list_registrations_rest_flattened(): + client = DomainsClient( + 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 = domains.ListRegistrationsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.ListRegistrationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_registrations(**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/v1beta1/{parent=projects/*/locations/*}/registrations" % client.transport._host, args[1]) + + +def test_list_registrations_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registrations( + domains.ListRegistrationsRequest(), + parent='parent_value', + ) + + +def test_list_registrations_rest_pager(transport: str = 'rest'): + client = DomainsClient( + 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 = ( + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + domains.Registration(), + ], + next_page_token='abc', + ), + domains.ListRegistrationsResponse( + registrations=[], + next_page_token='def', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + ], + next_page_token='ghi', + ), + domains.ListRegistrationsResponse( + registrations=[ + domains.Registration(), + domains.Registration(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(domains.ListRegistrationsResponse.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_registrations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, domains.Registration) + for i in results) + + pages = list(client.list_registrations(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + domains.GetRegistrationRequest, + dict, +]) +def test_get_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/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 = domains.Registration( + name='name_value', + domain_name='domain_name_value', + state=domains.Registration.State.REGISTRATION_PENDING, + issues=[domains.Registration.Issue.CONTACT_SUPPORT], + supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_registration(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.Registration) + assert response.name == 'name_value' + assert response.domain_name == 'domain_name_value' + assert response.state == domains.Registration.State.REGISTRATION_PENDING + assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] + assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] + + +def test_get_registration_rest_required_fields(request_type=domains.GetRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_registration._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_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.Registration() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_get_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_get_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.GetRegistrationRequest.pb(domains.GetRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.Registration.to_json(domains.Registration()) + + request = domains.GetRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.Registration() + + client.get_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_registration_rest_bad_request(transport: str = 'rest', request_type=domains.GetRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_registration(request) + + +def test_get_registration_rest_flattened(): + client = DomainsClient( + 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 = domains.Registration() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.Registration.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) + + +def test_get_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.GetRegistrationRequest(), + name='name_value', + ) + + +def test_get_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.UpdateRegistrationRequest, + dict, +]) +def test_update_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_registration_rest_required_fields(request_type=domains.UpdateRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_update_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_update_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.UpdateRegistrationRequest.pb(domains.UpdateRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.UpdateRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_registration_rest_bad_request(transport: str = 'rest', request_type=domains.UpdateRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_registration(request) + + +def test_update_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_registration(**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/v1beta1/{registration.name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) + + +def test_update_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.UpdateRegistrationRequest(), + registration=domains.Registration(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureManagementSettingsRequest, + dict, +]) +def test_configure_management_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_management_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_management_settings_rest_required_fields(request_type=domains.ConfigureManagementSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_management_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_management_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_management_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_management_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_management_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_management_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureManagementSettingsRequest.pb(domains.ConfigureManagementSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureManagementSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_management_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_management_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureManagementSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_management_settings(request) + + +def test_configure_management_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_management_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings" % client.transport._host, args[1]) + + +def test_configure_management_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_management_settings( + domains.ConfigureManagementSettingsRequest(), + registration='registration_value', + management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_management_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureDnsSettingsRequest, + dict, +]) +def test_configure_dns_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_dns_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_dns_settings_rest_required_fields(request_type=domains.ConfigureDnsSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_dns_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_dns_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_dns_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_dns_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_dns_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_dns_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureDnsSettingsRequest.pb(domains.ConfigureDnsSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureDnsSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_dns_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_dns_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureDnsSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_dns_settings(request) + + +def test_configure_dns_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_dns_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings" % client.transport._host, args[1]) + + +def test_configure_dns_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_dns_settings( + domains.ConfigureDnsSettingsRequest(), + registration='registration_value', + dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_dns_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ConfigureContactSettingsRequest, + dict, +]) +def test_configure_contact_settings_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.configure_contact_settings(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_configure_contact_settings_rest_required_fields(request_type=domains.ConfigureContactSettingsRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.configure_contact_settings(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_configure_contact_settings_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.configure_contact_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_configure_contact_settings_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_configure_contact_settings") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_contact_settings") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ConfigureContactSettingsRequest.pb(domains.ConfigureContactSettingsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ConfigureContactSettingsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.configure_contact_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_configure_contact_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureContactSettingsRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.configure_contact_settings(request) + + +def test_configure_contact_settings_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.configure_contact_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings" % client.transport._host, args[1]) + + +def test_configure_contact_settings_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.configure_contact_settings( + domains.ConfigureContactSettingsRequest(), + registration='registration_value', + contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_configure_contact_settings_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ExportRegistrationRequest, + dict, +]) +def test_export_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.export_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_export_registration_rest_required_fields(request_type=domains.ExportRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).export_registration._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()).export_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.export_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_export_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.export_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_export_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_export_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_export_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ExportRegistrationRequest.pb(domains.ExportRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.ExportRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.export_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_export_registration_rest_bad_request(transport: str = 'rest', request_type=domains.ExportRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.export_registration(request) + + +def test_export_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.export_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}:export" % client.transport._host, args[1]) + + +def test_export_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.export_registration( + domains.ExportRegistrationRequest(), + name='name_value', + ) + + +def test_export_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.DeleteRegistrationRequest, + dict, +]) +def test_delete_registration_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_registration(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_registration_rest_required_fields(request_type=domains.DeleteRegistrationRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_registration._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_registration._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 = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_registration(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_registration_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_registration._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_registration_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.DomainsRestInterceptor, "post_delete_registration") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_delete_registration") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.DeleteRegistrationRequest.pb(domains.DeleteRegistrationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = domains.DeleteRegistrationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_registration_rest_bad_request(transport: str = 'rest', request_type=domains.DeleteRegistrationRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_registration(request) + + +def test_delete_registration_rest_flattened(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) + + +def test_delete_registration_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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_registration( + domains.DeleteRegistrationRequest(), + name='name_value', + ) + + +def test_delete_registration_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.RetrieveAuthorizationCodeRequest, + dict, +]) +def test_retrieve_authorization_code_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( + code='code_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.retrieve_authorization_code(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_retrieve_authorization_code_rest_required_fields(request_type=domains.RetrieveAuthorizationCodeRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.AuthorizationCode() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.retrieve_authorization_code(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_retrieve_authorization_code_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.retrieve_authorization_code._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_retrieve_authorization_code_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_authorization_code") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_authorization_code") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.RetrieveAuthorizationCodeRequest.pb(domains.RetrieveAuthorizationCodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) + + request = domains.RetrieveAuthorizationCodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.AuthorizationCode() + + client.retrieve_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_retrieve_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveAuthorizationCodeRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.retrieve_authorization_code(request) + + +def test_retrieve_authorization_code_rest_flattened(): + client = DomainsClient( + 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 = domains.AuthorizationCode() + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.retrieve_authorization_code(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode" % client.transport._host, args[1]) + + +def test_retrieve_authorization_code_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.retrieve_authorization_code( + domains.RetrieveAuthorizationCodeRequest(), + registration='registration_value', + ) + + +def test_retrieve_authorization_code_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + domains.ResetAuthorizationCodeRequest, + dict, +]) +def test_reset_authorization_code_rest(request_type): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( + code='code_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.reset_authorization_code(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, domains.AuthorizationCode) + assert response.code == 'code_value' + + +def test_reset_authorization_code_rest_required_fields(request_type=domains.ResetAuthorizationCodeRequest): + transport_class = transports.DomainsRestTransport + + request_init = {} + request_init["registration"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["registration"] = 'registration_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "registration" in jsonified_request + assert jsonified_request["registration"] == 'registration_value' + + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = domains.AuthorizationCode() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.reset_authorization_code(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_reset_authorization_code_rest_unset_required_fields(): + transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.reset_authorization_code._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("registration", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_reset_authorization_code_rest_interceptors(null_interceptor): + transport = transports.DomainsRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), + ) + client = DomainsClient(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.DomainsRestInterceptor, "post_reset_authorization_code") as post, \ + mock.patch.object(transports.DomainsRestInterceptor, "pre_reset_authorization_code") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = domains.ResetAuthorizationCodeRequest.pb(domains.ResetAuthorizationCodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) + + request = domains.ResetAuthorizationCodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = domains.AuthorizationCode() + + client.reset_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_reset_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.ResetAuthorizationCodeRequest): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.reset_authorization_code(request) + + +def test_reset_authorization_code_rest_flattened(): + client = DomainsClient( + 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 = domains.AuthorizationCode() + + # get arguments that satisfy an http rule for this method + sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + registration='registration_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = domains.AuthorizationCode.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.reset_authorization_code(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode" % client.transport._host, args[1]) + + +def test_reset_authorization_code_rest_flattened_error(transport: str = 'rest'): + client = DomainsClient( + 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.reset_authorization_code( + domains.ResetAuthorizationCodeRequest(), + registration='registration_value', + ) + + +def test_reset_authorization_code_rest_error(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = DomainsClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = DomainsClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DomainsClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = DomainsClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.DomainsGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.DomainsGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + transports.DomainsRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = DomainsClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.DomainsGrpcTransport, + ) + +def test_domains_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.DomainsTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_domains_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.domains_v1beta1.services.domains.transports.DomainsTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.DomainsTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'search_domains', + 'retrieve_register_parameters', + 'register_domain', + 'retrieve_transfer_parameters', + 'transfer_domain', + 'list_registrations', + 'get_registration', + 'update_registration', + 'configure_management_settings', + 'configure_dns_settings', + 'configure_contact_settings', + 'export_registration', + 'delete_registration', + 'retrieve_authorization_code', + 'reset_authorization_code', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_domains_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.domains_v1beta1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.DomainsTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_domains_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.domains_v1beta1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.DomainsTransport() + adc.assert_called_once() + + +def test_domains_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) + DomainsClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + ], +) +def test_domains_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.DomainsGrpcTransport, + transports.DomainsGrpcAsyncIOTransport, + transports.DomainsRestTransport, + ], +) +def test_domains_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.DomainsGrpcTransport, grpc_helpers), + (transports.DomainsGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_domains_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( + "domains.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="domains.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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_domains_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.DomainsRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_domains_rest_lro_client(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_domains_host_no_port(transport_name): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'domains.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://domains.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_domains_host_with_port(transport_name): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'domains.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://domains.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_domains_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = DomainsClient( + credentials=creds1, + transport=transport_name, + ) + client2 = DomainsClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.search_domains._session + session2 = client2.transport.search_domains._session + assert session1 != session2 + session1 = client1.transport.retrieve_register_parameters._session + session2 = client2.transport.retrieve_register_parameters._session + assert session1 != session2 + session1 = client1.transport.register_domain._session + session2 = client2.transport.register_domain._session + assert session1 != session2 + session1 = client1.transport.retrieve_transfer_parameters._session + session2 = client2.transport.retrieve_transfer_parameters._session + assert session1 != session2 + session1 = client1.transport.transfer_domain._session + session2 = client2.transport.transfer_domain._session + assert session1 != session2 + session1 = client1.transport.list_registrations._session + session2 = client2.transport.list_registrations._session + assert session1 != session2 + session1 = client1.transport.get_registration._session + session2 = client2.transport.get_registration._session + assert session1 != session2 + session1 = client1.transport.update_registration._session + session2 = client2.transport.update_registration._session + assert session1 != session2 + session1 = client1.transport.configure_management_settings._session + session2 = client2.transport.configure_management_settings._session + assert session1 != session2 + session1 = client1.transport.configure_dns_settings._session + session2 = client2.transport.configure_dns_settings._session + assert session1 != session2 + session1 = client1.transport.configure_contact_settings._session + session2 = client2.transport.configure_contact_settings._session + assert session1 != session2 + session1 = client1.transport.export_registration._session + session2 = client2.transport.export_registration._session + assert session1 != session2 + session1 = client1.transport.delete_registration._session + session2 = client2.transport.delete_registration._session + assert session1 != session2 + session1 = client1.transport.retrieve_authorization_code._session + session2 = client2.transport.retrieve_authorization_code._session + assert session1 != session2 + session1 = client1.transport.reset_authorization_code._session + session2 = client2.transport.reset_authorization_code._session + assert session1 != session2 +def test_domains_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.DomainsGrpcTransport( + 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_domains_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.DomainsGrpcAsyncIOTransport( + 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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) +def test_domains_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_domains_grpc_lro_client(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_domains_grpc_lro_async_client(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_registration_path(): + project = "squid" + location = "clam" + registration = "whelk" + expected = "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) + actual = DomainsClient.registration_path(project, location, registration) + assert expected == actual + + +def test_parse_registration_path(): + expected = { + "project": "octopus", + "location": "oyster", + "registration": "nudibranch", + } + path = DomainsClient.registration_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_registration_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = DomainsClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = DomainsClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = DomainsClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = DomainsClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = DomainsClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = DomainsClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = DomainsClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = DomainsClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.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 = DomainsClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = DomainsClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = DomainsClient.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.DomainsTransport, '_prep_wrapped_messages') as prep: + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.DomainsTransport, '_prep_wrapped_messages') as prep: + transport_class = DomainsClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = DomainsAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = DomainsClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = DomainsClient( + 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", [ + (DomainsClient, transports.DomainsGrpcTransport), + (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) From 0f2f680086d72ddd339482285c9852635bf19cff Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:27:13 +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 --- .../services/domains/async_client.py | 45 +- .../domains_v1/services/domains/client.py | 45 +- .../services/domains/async_client.py | 45 +- .../services/domains/client.py | 45 +- owl-bot-staging/v1/.coveragerc | 13 - owl-bot-staging/v1/.flake8 | 33 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 - .../v1/docs/domains_v1/domains.rst | 10 - .../v1/docs/domains_v1/services.rst | 6 - owl-bot-staging/v1/docs/domains_v1/types.rst | 6 - owl-bot-staging/v1/docs/index.rst | 7 - .../v1/google/cloud/domains/__init__.py | 89 - .../v1/google/cloud/domains/gapic_version.py | 16 - .../v1/google/cloud/domains/py.typed | 2 - .../v1/google/cloud/domains_v1/__init__.py | 90 - .../cloud/domains_v1/gapic_metadata.json | 253 - .../google/cloud/domains_v1/gapic_version.py | 16 - .../v1/google/cloud/domains_v1/py.typed | 2 - .../cloud/domains_v1/services/__init__.py | 15 - .../domains_v1/services/domains/__init__.py | 22 - .../services/domains/async_client.py | 2284 ----- .../domains_v1/services/domains/client.py | 2488 ----- .../domains_v1/services/domains/pagers.py | 139 - .../services/domains/transports/__init__.py | 38 - .../services/domains/transports/base.py | 351 - .../services/domains/transports/grpc.py | 742 -- .../domains/transports/grpc_asyncio.py | 741 -- .../services/domains/transports/rest.py | 1976 ---- .../google/cloud/domains_v1/types/__init__.py | 82 - .../google/cloud/domains_v1/types/domains.py | 1523 --- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 184 - ...omains_configure_contact_settings_async.py | 56 - ...domains_configure_contact_settings_sync.py | 56 - ...ed_domains_configure_dns_settings_async.py | 56 - ...ted_domains_configure_dns_settings_sync.py | 56 - ...ins_configure_management_settings_async.py | 56 - ...ains_configure_management_settings_sync.py | 56 - ...rated_domains_delete_registration_async.py | 56 - ...erated_domains_delete_registration_sync.py | 56 - ...rated_domains_export_registration_async.py | 56 - ...erated_domains_export_registration_sync.py | 56 - ...enerated_domains_get_registration_async.py | 52 - ...generated_domains_get_registration_sync.py | 52 - ...erated_domains_list_registrations_async.py | 53 - ...nerated_domains_list_registrations_sync.py | 53 - ...generated_domains_register_domain_async.py | 67 - ..._generated_domains_register_domain_sync.py | 67 - ..._domains_reset_authorization_code_async.py | 52 - ...d_domains_reset_authorization_code_sync.py | 52 - ...mains_retrieve_authorization_code_async.py | 52 - ...omains_retrieve_authorization_code_sync.py | 52 - ...ains_retrieve_register_parameters_async.py | 53 - ...mains_retrieve_register_parameters_sync.py | 53 - ...ains_retrieve_transfer_parameters_async.py | 53 - ...mains_retrieve_transfer_parameters_sync.py | 53 - ..._generated_domains_search_domains_async.py | 53 - ...1_generated_domains_search_domains_sync.py | 53 - ...generated_domains_transfer_domain_async.py | 67 - ..._generated_domains_transfer_domain_sync.py | 67 - ...rated_domains_update_registration_async.py | 55 - ...erated_domains_update_registration_sync.py | 55 - ...ppet_metadata_google.cloud.domains.v1.json | 2550 ----- .../v1/scripts/fixup_domains_v1_keywords.py | 190 - owl-bot-staging/v1/setup.py | 90 - .../v1/testing/constraints-3.10.txt | 6 - .../v1/testing/constraints-3.11.txt | 6 - .../v1/testing/constraints-3.12.txt | 6 - .../v1/testing/constraints-3.7.txt | 9 - .../v1/testing/constraints-3.8.txt | 6 - .../v1/testing/constraints-3.9.txt | 6 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../tests/unit/gapic/domains_v1/__init__.py | 16 - .../unit/gapic/domains_v1/test_domains.py | 8728 ----------------- owl-bot-staging/v1beta1/.coveragerc | 13 - owl-bot-staging/v1beta1/.flake8 | 33 - owl-bot-staging/v1beta1/MANIFEST.in | 2 - owl-bot-staging/v1beta1/README.rst | 49 - owl-bot-staging/v1beta1/docs/conf.py | 376 - .../v1beta1/docs/domains_v1beta1/domains.rst | 10 - .../v1beta1/docs/domains_v1beta1/services.rst | 6 - .../v1beta1/docs/domains_v1beta1/types.rst | 6 - owl-bot-staging/v1beta1/docs/index.rst | 7 - .../v1beta1/google/cloud/domains/__init__.py | 89 - .../google/cloud/domains/gapic_version.py | 16 - .../v1beta1/google/cloud/domains/py.typed | 2 - .../google/cloud/domains_v1beta1/__init__.py | 90 - .../cloud/domains_v1beta1/gapic_metadata.json | 253 - .../cloud/domains_v1beta1/gapic_version.py | 16 - .../google/cloud/domains_v1beta1/py.typed | 2 - .../domains_v1beta1/services/__init__.py | 15 - .../services/domains/__init__.py | 22 - .../services/domains/async_client.py | 2284 ----- .../services/domains/client.py | 2488 ----- .../services/domains/pagers.py | 139 - .../services/domains/transports/__init__.py | 38 - .../services/domains/transports/base.py | 351 - .../services/domains/transports/grpc.py | 742 -- .../domains/transports/grpc_asyncio.py | 741 -- .../services/domains/transports/rest.py | 1976 ---- .../cloud/domains_v1beta1/types/__init__.py | 82 - .../cloud/domains_v1beta1/types/domains.py | 1523 --- owl-bot-staging/v1beta1/mypy.ini | 3 - owl-bot-staging/v1beta1/noxfile.py | 184 - ...omains_configure_contact_settings_async.py | 56 - ...domains_configure_contact_settings_sync.py | 56 - ...ed_domains_configure_dns_settings_async.py | 56 - ...ted_domains_configure_dns_settings_sync.py | 56 - ...ins_configure_management_settings_async.py | 56 - ...ains_configure_management_settings_sync.py | 56 - ...rated_domains_delete_registration_async.py | 56 - ...erated_domains_delete_registration_sync.py | 56 - ...rated_domains_export_registration_async.py | 56 - ...erated_domains_export_registration_sync.py | 56 - ...enerated_domains_get_registration_async.py | 52 - ...generated_domains_get_registration_sync.py | 52 - ...erated_domains_list_registrations_async.py | 53 - ...nerated_domains_list_registrations_sync.py | 53 - ...generated_domains_register_domain_async.py | 67 - ..._generated_domains_register_domain_sync.py | 67 - ..._domains_reset_authorization_code_async.py | 52 - ...d_domains_reset_authorization_code_sync.py | 52 - ...mains_retrieve_authorization_code_async.py | 52 - ...omains_retrieve_authorization_code_sync.py | 52 - ...ains_retrieve_register_parameters_async.py | 53 - ...mains_retrieve_register_parameters_sync.py | 53 - ...ains_retrieve_transfer_parameters_async.py | 53 - ...mains_retrieve_transfer_parameters_sync.py | 53 - ..._generated_domains_search_domains_async.py | 53 - ...1_generated_domains_search_domains_sync.py | 53 - ...generated_domains_transfer_domain_async.py | 67 - ..._generated_domains_transfer_domain_sync.py | 67 - ...rated_domains_update_registration_async.py | 55 - ...erated_domains_update_registration_sync.py | 55 - ...metadata_google.cloud.domains.v1beta1.json | 2550 ----- .../scripts/fixup_domains_v1beta1_keywords.py | 190 - owl-bot-staging/v1beta1/setup.py | 90 - .../v1beta1/testing/constraints-3.10.txt | 6 - .../v1beta1/testing/constraints-3.11.txt | 6 - .../v1beta1/testing/constraints-3.12.txt | 6 - .../v1beta1/testing/constraints-3.7.txt | 9 - .../v1beta1/testing/constraints-3.8.txt | 6 - .../v1beta1/testing/constraints-3.9.txt | 6 - owl-bot-staging/v1beta1/tests/__init__.py | 16 - .../v1beta1/tests/unit/__init__.py | 16 - .../v1beta1/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/domains_v1beta1/__init__.py | 16 - .../gapic/domains_v1beta1/test_domains.py | 8728 ----------------- 152 files changed, 60 insertions(+), 49906 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/.flake8 delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/domains_v1/domains.rst delete mode 100644 owl-bot-staging/v1/docs/domains_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/domains_v1/types.rst delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/google/cloud/domains/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json delete mode 100644 owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py delete mode 100644 owl-bot-staging/v1beta1/.coveragerc delete mode 100644 owl-bot-staging/v1beta1/.flake8 delete mode 100644 owl-bot-staging/v1beta1/MANIFEST.in delete mode 100644 owl-bot-staging/v1beta1/README.rst delete mode 100644 owl-bot-staging/v1beta1/docs/conf.py delete mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst delete mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst delete mode 100644 owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst delete mode 100644 owl-bot-staging/v1beta1/docs/index.rst delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains/py.typed delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py delete mode 100644 owl-bot-staging/v1beta1/mypy.ini delete mode 100644 owl-bot-staging/v1beta1/noxfile.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py delete mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json delete mode 100644 owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py delete mode 100644 owl-bot-staging/v1beta1/setup.py delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/v1beta1/tests/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py diff --git a/google/cloud/domains_v1/services/domains/async_client.py b/google/cloud/domains_v1/services/domains/async_client.py index 3357ba1..0d57811 100644 --- a/google/cloud/domains_v1/services/domains/async_client.py +++ b/google/cloud/domains_v1/services/domains/async_client.py @@ -261,8 +261,7 @@ async def sample_search_domains(): Args: request (Optional[Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]]): - The request object. Request for the `SearchDomains` - method. + The request object. Request for the ``SearchDomains`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -376,8 +375,7 @@ async def sample_retrieve_register_parameters(): Args: request (Optional[Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]]): - The request object. Request for the - `RetrieveRegisterParameters` method. + The request object. Request for the ``RetrieveRegisterParameters`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -516,8 +514,7 @@ async def sample_register_domain(): Args: request (Optional[Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]]): - The request object. Request for the `RegisterDomain` - method. + The request object. Request for the ``RegisterDomain`` method. parent (:class:`str`): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -677,8 +674,7 @@ async def sample_retrieve_transfer_parameters(): Args: request (Optional[Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]]): - The request object. Request for the - `RetrieveTransferParameters` method. + The request object. Request for the ``RetrieveTransferParameters`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -828,8 +824,7 @@ async def sample_transfer_domain(): Args: request (Optional[Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]]): - The request object. Request for the `TransferDomain` - method. + The request object. Request for the ``TransferDomain`` method. parent (:class:`str`): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -1000,8 +995,7 @@ async def sample_list_registrations(): Args: request (Optional[Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]]): - The request object. Request for the `ListRegistrations` - method. + The request object. Request for the ``ListRegistrations`` method. parent (:class:`str`): Required. The project and location from which to list ``Registration``\ s, specified in the format @@ -1114,8 +1108,7 @@ async def sample_get_registration(): Args: request (Optional[Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]]): - The request object. Request for the `GetRegistration` - method. + The request object. Request for the ``GetRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to get, in the format ``projects/*/locations/*/registrations/*``. @@ -1248,8 +1241,7 @@ async def sample_update_registration(): Args: request (Optional[Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]]): - The request object. Request for the `UpdateRegistration` - method. + The request object. Request for the ``UpdateRegistration`` method. registration (:class:`google.cloud.domains_v1.types.Registration`): Fields of the ``Registration`` to update. This corresponds to the ``registration`` field @@ -1399,8 +1391,7 @@ async def sample_configure_management_settings(): Args: request (Optional[Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]]): - The request object. Request for the - `ConfigureManagementSettings` method. + The request object. Request for the ``ConfigureManagementSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose management settings are being updated, in the format @@ -1558,8 +1549,7 @@ async def sample_configure_dns_settings(): Args: request (Optional[Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]]): - The request object. Request for the - `ConfigureDnsSettings` method. + The request object. Request for the ``ConfigureDnsSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose DNS settings are being updated, in the format @@ -1725,8 +1715,7 @@ async def sample_configure_contact_settings(): Args: request (Optional[Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]]): - The request object. Request for the - `ConfigureContactSettings` method. + The request object. Request for the ``ConfigureContactSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose contact settings are being updated, in the format @@ -1891,8 +1880,7 @@ async def sample_export_registration(): Args: request (Optional[Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]]): - The request object. Request for the `ExportRegistration` - method. + The request object. Request for the ``ExportRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to export, in the format ``projects/*/locations/*/registrations/*``. @@ -2048,8 +2036,7 @@ async def sample_delete_registration(): Args: request (Optional[Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]]): - The request object. Request for the `DeleteRegistration` - method. + The request object. Request for the ``DeleteRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to delete, in the format ``projects/*/locations/*/registrations/*``. @@ -2172,8 +2159,7 @@ async def sample_retrieve_authorization_code(): Args: request (Optional[Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]]): - The request object. Request for the - `RetrieveAuthorizationCode` method. + The request object. Request for the ``RetrieveAuthorizationCode`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose authorization code is being retrieved, in the format @@ -2279,8 +2265,7 @@ async def sample_reset_authorization_code(): Args: request (Optional[Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]]): - The request object. Request for the - `ResetAuthorizationCode` method. + The request object. Request for the ``ResetAuthorizationCode`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose authorization code is being reset, in the format diff --git a/google/cloud/domains_v1/services/domains/client.py b/google/cloud/domains_v1/services/domains/client.py index c7ea405..1b027ec 100644 --- a/google/cloud/domains_v1/services/domains/client.py +++ b/google/cloud/domains_v1/services/domains/client.py @@ -496,8 +496,7 @@ def sample_search_domains(): Args: request (Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]): - The request object. Request for the `SearchDomains` - method. + The request object. Request for the ``SearchDomains`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -611,8 +610,7 @@ def sample_retrieve_register_parameters(): Args: request (Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]): - The request object. Request for the - `RetrieveRegisterParameters` method. + The request object. Request for the ``RetrieveRegisterParameters`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -753,8 +751,7 @@ def sample_register_domain(): Args: request (Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]): - The request object. Request for the `RegisterDomain` - method. + The request object. Request for the ``RegisterDomain`` method. parent (str): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -914,8 +911,7 @@ def sample_retrieve_transfer_parameters(): Args: request (Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]): - The request object. Request for the - `RetrieveTransferParameters` method. + The request object. Request for the ``RetrieveTransferParameters`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -1067,8 +1063,7 @@ def sample_transfer_domain(): Args: request (Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]): - The request object. Request for the `TransferDomain` - method. + The request object. Request for the ``TransferDomain`` method. parent (str): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -1239,8 +1234,7 @@ def sample_list_registrations(): Args: request (Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]): - The request object. Request for the `ListRegistrations` - method. + The request object. Request for the ``ListRegistrations`` method. parent (str): Required. The project and location from which to list ``Registration``\ s, specified in the format @@ -1353,8 +1347,7 @@ def sample_get_registration(): Args: request (Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]): - The request object. Request for the `GetRegistration` - method. + The request object. Request for the ``GetRegistration`` method. name (str): Required. The name of the ``Registration`` to get, in the format ``projects/*/locations/*/registrations/*``. @@ -1487,8 +1480,7 @@ def sample_update_registration(): Args: request (Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]): - The request object. Request for the `UpdateRegistration` - method. + The request object. Request for the ``UpdateRegistration`` method. registration (google.cloud.domains_v1.types.Registration): Fields of the ``Registration`` to update. This corresponds to the ``registration`` field @@ -1638,8 +1630,7 @@ def sample_configure_management_settings(): Args: request (Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]): - The request object. Request for the - `ConfigureManagementSettings` method. + The request object. Request for the ``ConfigureManagementSettings`` method. registration (str): Required. The name of the ``Registration`` whose management settings are being updated, in the format @@ -1799,8 +1790,7 @@ def sample_configure_dns_settings(): Args: request (Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]): - The request object. Request for the - `ConfigureDnsSettings` method. + The request object. Request for the ``ConfigureDnsSettings`` method. registration (str): Required. The name of the ``Registration`` whose DNS settings are being updated, in the format @@ -1966,8 +1956,7 @@ def sample_configure_contact_settings(): Args: request (Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]): - The request object. Request for the - `ConfigureContactSettings` method. + The request object. Request for the ``ConfigureContactSettings`` method. registration (str): Required. The name of the ``Registration`` whose contact settings are being updated, in the format @@ -2134,8 +2123,7 @@ def sample_export_registration(): Args: request (Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]): - The request object. Request for the `ExportRegistration` - method. + The request object. Request for the ``ExportRegistration`` method. name (str): Required. The name of the ``Registration`` to export, in the format ``projects/*/locations/*/registrations/*``. @@ -2291,8 +2279,7 @@ def sample_delete_registration(): Args: request (Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]): - The request object. Request for the `DeleteRegistration` - method. + The request object. Request for the ``DeleteRegistration`` method. name (str): Required. The name of the ``Registration`` to delete, in the format ``projects/*/locations/*/registrations/*``. @@ -2415,8 +2402,7 @@ def sample_retrieve_authorization_code(): Args: request (Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]): - The request object. Request for the - `RetrieveAuthorizationCode` method. + The request object. Request for the ``RetrieveAuthorizationCode`` method. registration (str): Required. The name of the ``Registration`` whose authorization code is being retrieved, in the format @@ -2524,8 +2510,7 @@ def sample_reset_authorization_code(): Args: request (Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]): - The request object. Request for the - `ResetAuthorizationCode` method. + The request object. Request for the ``ResetAuthorizationCode`` method. registration (str): Required. The name of the ``Registration`` whose authorization code is being reset, in the format diff --git a/google/cloud/domains_v1beta1/services/domains/async_client.py b/google/cloud/domains_v1beta1/services/domains/async_client.py index 8c0969e..3db6942 100644 --- a/google/cloud/domains_v1beta1/services/domains/async_client.py +++ b/google/cloud/domains_v1beta1/services/domains/async_client.py @@ -261,8 +261,7 @@ async def sample_search_domains(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]]): - The request object. Request for the `SearchDomains` - method. + The request object. Request for the ``SearchDomains`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -376,8 +375,7 @@ async def sample_retrieve_register_parameters(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]]): - The request object. Request for the - `RetrieveRegisterParameters` method. + The request object. Request for the ``RetrieveRegisterParameters`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -516,8 +514,7 @@ async def sample_register_domain(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]]): - The request object. Request for the `RegisterDomain` - method. + The request object. Request for the ``RegisterDomain`` method. parent (:class:`str`): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -677,8 +674,7 @@ async def sample_retrieve_transfer_parameters(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]]): - The request object. Request for the - `RetrieveTransferParameters` method. + The request object. Request for the ``RetrieveTransferParameters`` method. location (:class:`str`): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -828,8 +824,7 @@ async def sample_transfer_domain(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]]): - The request object. Request for the `TransferDomain` - method. + The request object. Request for the ``TransferDomain`` method. parent (:class:`str`): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -1000,8 +995,7 @@ async def sample_list_registrations(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]]): - The request object. Request for the `ListRegistrations` - method. + The request object. Request for the ``ListRegistrations`` method. parent (:class:`str`): Required. The project and location from which to list ``Registration``\ s, specified in the format @@ -1114,8 +1108,7 @@ async def sample_get_registration(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]]): - The request object. Request for the `GetRegistration` - method. + The request object. Request for the ``GetRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to get, in the format ``projects/*/locations/*/registrations/*``. @@ -1248,8 +1241,7 @@ async def sample_update_registration(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]]): - The request object. Request for the `UpdateRegistration` - method. + The request object. Request for the ``UpdateRegistration`` method. registration (:class:`google.cloud.domains_v1beta1.types.Registration`): Fields of the ``Registration`` to update. This corresponds to the ``registration`` field @@ -1399,8 +1391,7 @@ async def sample_configure_management_settings(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]]): - The request object. Request for the - `ConfigureManagementSettings` method. + The request object. Request for the ``ConfigureManagementSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose management settings are being updated, in the format @@ -1558,8 +1549,7 @@ async def sample_configure_dns_settings(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]]): - The request object. Request for the - `ConfigureDnsSettings` method. + The request object. Request for the ``ConfigureDnsSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose DNS settings are being updated, in the format @@ -1725,8 +1715,7 @@ async def sample_configure_contact_settings(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]]): - The request object. Request for the - `ConfigureContactSettings` method. + The request object. Request for the ``ConfigureContactSettings`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose contact settings are being updated, in the format @@ -1891,8 +1880,7 @@ async def sample_export_registration(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]]): - The request object. Request for the `ExportRegistration` - method. + The request object. Request for the ``ExportRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to export, in the format ``projects/*/locations/*/registrations/*``. @@ -2048,8 +2036,7 @@ async def sample_delete_registration(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]]): - The request object. Request for the `DeleteRegistration` - method. + The request object. Request for the ``DeleteRegistration`` method. name (:class:`str`): Required. The name of the ``Registration`` to delete, in the format ``projects/*/locations/*/registrations/*``. @@ -2172,8 +2159,7 @@ async def sample_retrieve_authorization_code(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]]): - The request object. Request for the - `RetrieveAuthorizationCode` method. + The request object. Request for the ``RetrieveAuthorizationCode`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose authorization code is being retrieved, in the format @@ -2279,8 +2265,7 @@ async def sample_reset_authorization_code(): Args: request (Optional[Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]]): - The request object. Request for the - `ResetAuthorizationCode` method. + The request object. Request for the ``ResetAuthorizationCode`` method. registration (:class:`str`): Required. The name of the ``Registration`` whose authorization code is being reset, in the format diff --git a/google/cloud/domains_v1beta1/services/domains/client.py b/google/cloud/domains_v1beta1/services/domains/client.py index b0274ae..48a1a73 100644 --- a/google/cloud/domains_v1beta1/services/domains/client.py +++ b/google/cloud/domains_v1beta1/services/domains/client.py @@ -496,8 +496,7 @@ def sample_search_domains(): Args: request (Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]): - The request object. Request for the `SearchDomains` - method. + The request object. Request for the ``SearchDomains`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -611,8 +610,7 @@ def sample_retrieve_register_parameters(): Args: request (Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]): - The request object. Request for the - `RetrieveRegisterParameters` method. + The request object. Request for the ``RetrieveRegisterParameters`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -753,8 +751,7 @@ def sample_register_domain(): Args: request (Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]): - The request object. Request for the `RegisterDomain` - method. + The request object. Request for the ``RegisterDomain`` method. parent (str): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -914,8 +911,7 @@ def sample_retrieve_transfer_parameters(): Args: request (Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]): - The request object. Request for the - `RetrieveTransferParameters` method. + The request object. Request for the ``RetrieveTransferParameters`` method. location (str): Required. The location. Must be in the format ``projects/*/locations/*``. @@ -1067,8 +1063,7 @@ def sample_transfer_domain(): Args: request (Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]): - The request object. Request for the `TransferDomain` - method. + The request object. Request for the ``TransferDomain`` method. parent (str): Required. The parent resource of the ``Registration``. Must be in the format ``projects/*/locations/*``. @@ -1239,8 +1234,7 @@ def sample_list_registrations(): Args: request (Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]): - The request object. Request for the `ListRegistrations` - method. + The request object. Request for the ``ListRegistrations`` method. parent (str): Required. The project and location from which to list ``Registration``\ s, specified in the format @@ -1353,8 +1347,7 @@ def sample_get_registration(): Args: request (Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]): - The request object. Request for the `GetRegistration` - method. + The request object. Request for the ``GetRegistration`` method. name (str): Required. The name of the ``Registration`` to get, in the format ``projects/*/locations/*/registrations/*``. @@ -1487,8 +1480,7 @@ def sample_update_registration(): Args: request (Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]): - The request object. Request for the `UpdateRegistration` - method. + The request object. Request for the ``UpdateRegistration`` method. registration (google.cloud.domains_v1beta1.types.Registration): Fields of the ``Registration`` to update. This corresponds to the ``registration`` field @@ -1638,8 +1630,7 @@ def sample_configure_management_settings(): Args: request (Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]): - The request object. Request for the - `ConfigureManagementSettings` method. + The request object. Request for the ``ConfigureManagementSettings`` method. registration (str): Required. The name of the ``Registration`` whose management settings are being updated, in the format @@ -1799,8 +1790,7 @@ def sample_configure_dns_settings(): Args: request (Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]): - The request object. Request for the - `ConfigureDnsSettings` method. + The request object. Request for the ``ConfigureDnsSettings`` method. registration (str): Required. The name of the ``Registration`` whose DNS settings are being updated, in the format @@ -1966,8 +1956,7 @@ def sample_configure_contact_settings(): Args: request (Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]): - The request object. Request for the - `ConfigureContactSettings` method. + The request object. Request for the ``ConfigureContactSettings`` method. registration (str): Required. The name of the ``Registration`` whose contact settings are being updated, in the format @@ -2134,8 +2123,7 @@ def sample_export_registration(): Args: request (Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]): - The request object. Request for the `ExportRegistration` - method. + The request object. Request for the ``ExportRegistration`` method. name (str): Required. The name of the ``Registration`` to export, in the format ``projects/*/locations/*/registrations/*``. @@ -2291,8 +2279,7 @@ def sample_delete_registration(): Args: request (Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]): - The request object. Request for the `DeleteRegistration` - method. + The request object. Request for the ``DeleteRegistration`` method. name (str): Required. The name of the ``Registration`` to delete, in the format ``projects/*/locations/*/registrations/*``. @@ -2415,8 +2402,7 @@ def sample_retrieve_authorization_code(): Args: request (Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]): - The request object. Request for the - `RetrieveAuthorizationCode` method. + The request object. Request for the ``RetrieveAuthorizationCode`` method. registration (str): Required. The name of the ``Registration`` whose authorization code is being retrieved, in the format @@ -2524,8 +2510,7 @@ def sample_reset_authorization_code(): Args: request (Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]): - The request object. Request for the - `ResetAuthorizationCode` method. + The request object. Request for the ``ResetAuthorizationCode`` method. registration (str): Required. The name of the ``Registration`` whose authorization code is being reset, in the format diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index 4cecf7e..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/domains/__init__.py - google/cloud/domains/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v1/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 44b9d49..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/domains *.py -recursive-include google/cloud/domains_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 6f21f3f..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Domains 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 Domains API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 2345777..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-domains documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-cloud-domains" -copyright = u"2022, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-domains-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-domains.tex", - u"google-cloud-domains 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-domains", - u"Google Cloud Domains 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-domains", - u"google-cloud-domains Documentation", - author, - "google-cloud-domains", - "GAPIC library for Google Cloud Domains API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/domains_v1/domains.rst b/owl-bot-staging/v1/docs/domains_v1/domains.rst deleted file mode 100644 index bfb140d..0000000 --- a/owl-bot-staging/v1/docs/domains_v1/domains.rst +++ /dev/null @@ -1,10 +0,0 @@ -Domains -------------------------- - -.. automodule:: google.cloud.domains_v1.services.domains - :members: - :inherited-members: - -.. automodule:: google.cloud.domains_v1.services.domains.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/domains_v1/services.rst b/owl-bot-staging/v1/docs/domains_v1/services.rst deleted file mode 100644 index 1073e86..0000000 --- a/owl-bot-staging/v1/docs/domains_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Domains v1 API -======================================== -.. toctree:: - :maxdepth: 2 - - domains diff --git a/owl-bot-staging/v1/docs/domains_v1/types.rst b/owl-bot-staging/v1/docs/domains_v1/types.rst deleted file mode 100644 index f2fefd0..0000000 --- a/owl-bot-staging/v1/docs/domains_v1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Domains v1 API -===================================== - -.. automodule:: google.cloud.domains_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index e880d37..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - domains_v1/services - domains_v1/types diff --git a/owl-bot-staging/v1/google/cloud/domains/__init__.py b/owl-bot-staging/v1/google/cloud/domains/__init__.py deleted file mode 100644 index d40dce0..0000000 --- a/owl-bot-staging/v1/google/cloud/domains/__init__.py +++ /dev/null @@ -1,89 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.domains import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.domains_v1.services.domains.client import DomainsClient -from google.cloud.domains_v1.services.domains.async_client import DomainsAsyncClient - -from google.cloud.domains_v1.types.domains import AuthorizationCode -from google.cloud.domains_v1.types.domains import ConfigureContactSettingsRequest -from google.cloud.domains_v1.types.domains import ConfigureDnsSettingsRequest -from google.cloud.domains_v1.types.domains import ConfigureManagementSettingsRequest -from google.cloud.domains_v1.types.domains import ContactSettings -from google.cloud.domains_v1.types.domains import DeleteRegistrationRequest -from google.cloud.domains_v1.types.domains import DnsSettings -from google.cloud.domains_v1.types.domains import ExportRegistrationRequest -from google.cloud.domains_v1.types.domains import GetRegistrationRequest -from google.cloud.domains_v1.types.domains import ListRegistrationsRequest -from google.cloud.domains_v1.types.domains import ListRegistrationsResponse -from google.cloud.domains_v1.types.domains import ManagementSettings -from google.cloud.domains_v1.types.domains import OperationMetadata -from google.cloud.domains_v1.types.domains import RegisterDomainRequest -from google.cloud.domains_v1.types.domains import RegisterParameters -from google.cloud.domains_v1.types.domains import Registration -from google.cloud.domains_v1.types.domains import ResetAuthorizationCodeRequest -from google.cloud.domains_v1.types.domains import RetrieveAuthorizationCodeRequest -from google.cloud.domains_v1.types.domains import RetrieveRegisterParametersRequest -from google.cloud.domains_v1.types.domains import RetrieveRegisterParametersResponse -from google.cloud.domains_v1.types.domains import RetrieveTransferParametersRequest -from google.cloud.domains_v1.types.domains import RetrieveTransferParametersResponse -from google.cloud.domains_v1.types.domains import SearchDomainsRequest -from google.cloud.domains_v1.types.domains import SearchDomainsResponse -from google.cloud.domains_v1.types.domains import TransferDomainRequest -from google.cloud.domains_v1.types.domains import TransferParameters -from google.cloud.domains_v1.types.domains import UpdateRegistrationRequest -from google.cloud.domains_v1.types.domains import ContactNotice -from google.cloud.domains_v1.types.domains import ContactPrivacy -from google.cloud.domains_v1.types.domains import DomainNotice -from google.cloud.domains_v1.types.domains import TransferLockState - -__all__ = ('DomainsClient', - 'DomainsAsyncClient', - 'AuthorizationCode', - 'ConfigureContactSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureManagementSettingsRequest', - 'ContactSettings', - 'DeleteRegistrationRequest', - 'DnsSettings', - 'ExportRegistrationRequest', - 'GetRegistrationRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'ManagementSettings', - 'OperationMetadata', - 'RegisterDomainRequest', - 'RegisterParameters', - 'Registration', - 'ResetAuthorizationCodeRequest', - 'RetrieveAuthorizationCodeRequest', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'TransferDomainRequest', - 'TransferParameters', - 'UpdateRegistrationRequest', - 'ContactNotice', - 'ContactPrivacy', - 'DomainNotice', - 'TransferLockState', -) diff --git a/owl-bot-staging/v1/google/cloud/domains/gapic_version.py b/owl-bot-staging/v1/google/cloud/domains/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/domains/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/domains/py.typed b/owl-bot-staging/v1/google/cloud/domains/py.typed deleted file mode 100644 index b463d6c..0000000 --- a/owl-bot-staging/v1/google/cloud/domains/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py deleted file mode 100644 index 60fe31b..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/__init__.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.domains_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.domains import DomainsClient -from .services.domains import DomainsAsyncClient - -from .types.domains import AuthorizationCode -from .types.domains import ConfigureContactSettingsRequest -from .types.domains import ConfigureDnsSettingsRequest -from .types.domains import ConfigureManagementSettingsRequest -from .types.domains import ContactSettings -from .types.domains import DeleteRegistrationRequest -from .types.domains import DnsSettings -from .types.domains import ExportRegistrationRequest -from .types.domains import GetRegistrationRequest -from .types.domains import ListRegistrationsRequest -from .types.domains import ListRegistrationsResponse -from .types.domains import ManagementSettings -from .types.domains import OperationMetadata -from .types.domains import RegisterDomainRequest -from .types.domains import RegisterParameters -from .types.domains import Registration -from .types.domains import ResetAuthorizationCodeRequest -from .types.domains import RetrieveAuthorizationCodeRequest -from .types.domains import RetrieveRegisterParametersRequest -from .types.domains import RetrieveRegisterParametersResponse -from .types.domains import RetrieveTransferParametersRequest -from .types.domains import RetrieveTransferParametersResponse -from .types.domains import SearchDomainsRequest -from .types.domains import SearchDomainsResponse -from .types.domains import TransferDomainRequest -from .types.domains import TransferParameters -from .types.domains import UpdateRegistrationRequest -from .types.domains import ContactNotice -from .types.domains import ContactPrivacy -from .types.domains import DomainNotice -from .types.domains import TransferLockState - -__all__ = ( - 'DomainsAsyncClient', -'AuthorizationCode', -'ConfigureContactSettingsRequest', -'ConfigureDnsSettingsRequest', -'ConfigureManagementSettingsRequest', -'ContactNotice', -'ContactPrivacy', -'ContactSettings', -'DeleteRegistrationRequest', -'DnsSettings', -'DomainNotice', -'DomainsClient', -'ExportRegistrationRequest', -'GetRegistrationRequest', -'ListRegistrationsRequest', -'ListRegistrationsResponse', -'ManagementSettings', -'OperationMetadata', -'RegisterDomainRequest', -'RegisterParameters', -'Registration', -'ResetAuthorizationCodeRequest', -'RetrieveAuthorizationCodeRequest', -'RetrieveRegisterParametersRequest', -'RetrieveRegisterParametersResponse', -'RetrieveTransferParametersRequest', -'RetrieveTransferParametersResponse', -'SearchDomainsRequest', -'SearchDomainsResponse', -'TransferDomainRequest', -'TransferLockState', -'TransferParameters', -'UpdateRegistrationRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json deleted file mode 100644 index a2b2080..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_metadata.json +++ /dev/null @@ -1,253 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.domains_v1", - "protoPackage": "google.cloud.domains.v1", - "schema": "1.0", - "services": { - "Domains": { - "clients": { - "grpc": { - "libraryClient": "DomainsClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - }, - "grpc-async": { - "libraryClient": "DomainsAsyncClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - }, - "rest": { - "libraryClient": "DomainsClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/py.typed b/owl-bot-staging/v1/google/cloud/domains_v1/py.typed deleted file mode 100644 index b463d6c..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py deleted file mode 100644 index e8e1c38..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py deleted file mode 100644 index 28d2584..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import DomainsClient -from .async_client import DomainsAsyncClient - -__all__ = ( - 'DomainsClient', - 'DomainsAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py deleted file mode 100644 index 0ba840c..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/async_client.py +++ /dev/null @@ -1,2284 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.domains_v1 import gapic_version as package_version - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.domains_v1.services.domains import pagers -from google.cloud.domains_v1.types import domains -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport -from .client import DomainsClient - - -class DomainsAsyncClient: - """The Cloud Domains API enables management and configuration of - domain names. - """ - - _client: DomainsClient - - DEFAULT_ENDPOINT = DomainsClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = DomainsClient.DEFAULT_MTLS_ENDPOINT - - registration_path = staticmethod(DomainsClient.registration_path) - parse_registration_path = staticmethod(DomainsClient.parse_registration_path) - common_billing_account_path = staticmethod(DomainsClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(DomainsClient.parse_common_billing_account_path) - common_folder_path = staticmethod(DomainsClient.common_folder_path) - parse_common_folder_path = staticmethod(DomainsClient.parse_common_folder_path) - common_organization_path = staticmethod(DomainsClient.common_organization_path) - parse_common_organization_path = staticmethod(DomainsClient.parse_common_organization_path) - common_project_path = staticmethod(DomainsClient.common_project_path) - parse_common_project_path = staticmethod(DomainsClient.parse_common_project_path) - common_location_path = staticmethod(DomainsClient.common_location_path) - parse_common_location_path = staticmethod(DomainsClient.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: - DomainsAsyncClient: The constructed client. - """ - return DomainsClient.from_service_account_info.__func__(DomainsAsyncClient, 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: - DomainsAsyncClient: The constructed client. - """ - return DomainsClient.from_service_account_file.__func__(DomainsAsyncClient, 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 DomainsClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> DomainsTransport: - """Returns the transport used by the client instance. - - Returns: - DomainsTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(DomainsClient).get_transport_class, type(DomainsClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, DomainsTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the domains client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.DomainsTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = DomainsClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def search_domains(self, - request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, - *, - location: 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, str]] = (), - ) -> domains.SearchDomainsResponse: - r"""Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - .. 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 domains_v1 - - async def sample_search_domains(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = await client.search_domains(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]]): - The request object. Request for the ``SearchDomains`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Required. String used to search for - available domain names. - - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.SearchDomainsResponse: - Response for the SearchDomains method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, query]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.SearchDomainsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.search_domains, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def retrieve_register_parameters(self, - request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - .. 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 domains_v1 - - async def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]]): - The request object. Request for the ``RetrieveRegisterParameters`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (:class:`str`): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.RetrieveRegisterParametersResponse: - Response for the RetrieveRegisterParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveRegisterParametersRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_register_parameters, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def register_domain(self, - request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - .. 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 domains_v1 - - async def sample_register_domain(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]]): - The request object. Request for the ``RegisterDomain`` method. - parent (:class:`str`): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (:class:`google.cloud.domains_v1.types.Registration`): - Required. The complete ``Registration`` resource to be - created. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (:class:`google.type.money_pb2.Money`): - Required. Yearly price to register or - renew the domain. The value that should - be put here can be obtained from - RetrieveRegisterParameters or - SearchDomains calls. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RegisterDomainRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.register_domain, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def retrieve_transfer_parameters(self, - request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveTransferParametersResponse: - r"""Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - .. 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 domains_v1 - - async def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]]): - The request object. Request for the ``RetrieveTransferParameters`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (:class:`str`): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.RetrieveTransferParametersResponse: - Response for the RetrieveTransferParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveTransferParametersRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_transfer_parameters, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def transfer_domain(self, - request: Optional[Union[domains.TransferDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - authorization_code: Optional[domains.AuthorizationCode] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - .. 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 domains_v1 - - async def sample_transfer_domain(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]]): - The request object. Request for the ``TransferDomain`` method. - parent (:class:`str`): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (:class:`google.cloud.domains_v1.types.Registration`): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to - import the domain's current DNS configuration from its - current registrar. Use this option only if you are sure - that the domain's current DNS service does not cease - upon transfer, as is often the case for DNS services - provided for free by the registrar. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (:class:`google.type.money_pb2.Money`): - Required. Acknowledgement of the price to transfer or - renew the domain for one year. Call - ``RetrieveTransferParameters`` to obtain the price, - which you must acknowledge. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - authorization_code (:class:`google.cloud.domains_v1.types.AuthorizationCode`): - The domain's transfer authorization - code. You can obtain this from the - domain's current registrar. - - This corresponds to the ``authorization_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price, authorization_code]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.TransferDomainRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - if authorization_code is not None: - request.authorization_code = authorization_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.transfer_domain, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def list_registrations(self, - request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRegistrationsAsyncPager: - r"""Lists the ``Registration`` resources in a 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 domains_v1 - - async def sample_list_registrations(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]]): - The request object. Request for the ``ListRegistrations`` method. - parent (:class:`str`): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager: - Response for the ListRegistrations method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ListRegistrationsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_registrations, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListRegistrationsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_registration(self, - request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.Registration: - r"""Gets the details of a ``Registration`` 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 domains_v1 - - async def sample_get_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_registration(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]]): - The request object. Request for the ``GetRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to get, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.Registration: - The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.GetRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_registration(self, - request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, - *, - registration: Optional[domains.Registration] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - .. 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 domains_v1 - - async def sample_update_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]]): - The request object. Request for the ``UpdateRegistration`` method. - registration (:class:`google.cloud.domains_v1.types.Registration`): - Fields of the ``Registration`` to update. - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the labels are being updated, the ``update_mask`` is - ``"labels"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.UpdateRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration.name", request.registration.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_management_settings(self, - request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - management_settings: Optional[domains.ManagementSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s management settings. - - .. 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 domains_v1 - - async def sample_configure_management_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]]): - The request object. Request for the ``ConfigureManagementSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - management settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - management_settings (:class:`google.cloud.domains_v1.types.ManagementSettings`): - Fields of the ``ManagementSettings`` to update. - This corresponds to the ``management_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the transfer lock is being updated, the ``update_mask`` - is ``"transfer_lock_state"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, management_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureManagementSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if management_settings is not None: - request.management_settings = management_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_management_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_dns_settings(self, - request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - dns_settings: Optional[domains.DnsSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s DNS settings. - - .. 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 domains_v1 - - async def sample_configure_dns_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]]): - The request object. Request for the ``ConfigureDnsSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - dns_settings (:class:`google.cloud.domains_v1.types.DnsSettings`): - Fields of the ``DnsSettings`` to update. - This corresponds to the ``dns_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the name servers are being updated for an existing - Custom DNS configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains - DNS configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, dns_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureDnsSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if dns_settings is not None: - request.dns_settings = dns_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_dns_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_contact_settings(self, - request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - contact_settings: Optional[domains.ContactSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - .. 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 domains_v1 - - async def sample_configure_contact_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]]): - The request object. Request for the ``ConfigureContactSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact_settings (:class:`google.cloud.domains_v1.types.ContactSettings`): - Fields of the ``ContactSettings`` to update. - This corresponds to the ``contact_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the registrant contact is being updated, the - ``update_mask`` is ``"registrant_contact"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, contact_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureContactSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if contact_settings is not None: - request.contact_settings = contact_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_contact_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def export_registration(self, - request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1 - - async def sample_export_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]]): - The request object. Request for the ``ExportRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to export, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ExportRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.export_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def delete_registration(self, - request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1 - - async def sample_delete_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]]): - The request object. Request for the ``DeleteRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to delete, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.DeleteRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - empty_pb2.Empty, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def retrieve_authorization_code(self, - request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1 - - async def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]]): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveAuthorizationCodeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_authorization_code, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def reset_authorization_code(self, - request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1 - - async def sample_reset_authorization_code(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.reset_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]]): - The request object. Request for the ``ResetAuthorizationCode`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ResetAuthorizationCodeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.reset_authorization_code, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "DomainsAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py deleted file mode 100644 index f529eee..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/client.py +++ /dev/null @@ -1,2488 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.domains_v1 import gapic_version as package_version - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.domains_v1.services.domains import pagers -from google.cloud.domains_v1.types import domains -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import DomainsGrpcTransport -from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport -from .transports.rest import DomainsRestTransport - - -class DomainsClientMeta(type): - """Metaclass for the Domains 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[DomainsTransport]] - _transport_registry["grpc"] = DomainsGrpcTransport - _transport_registry["grpc_asyncio"] = DomainsGrpcAsyncIOTransport - _transport_registry["rest"] = DomainsRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[DomainsTransport]: - """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 DomainsClient(metaclass=DomainsClientMeta): - """The Cloud Domains API enables management and configuration of - domain names. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "domains.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - DomainsClient: 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: - DomainsClient: 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) -> DomainsTransport: - """Returns the transport used by the client instance. - - Returns: - DomainsTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def registration_path(project: str,location: str,registration: str,) -> str: - """Returns a fully-qualified registration string.""" - return "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) - - @staticmethod - def parse_registration_path(path: str) -> Dict[str,str]: - """Parses a registration path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/registrations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, DomainsTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the domains client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, DomainsTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - client_options = cast(client_options_lib.ClientOptions, client_options) - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, DomainsTransport): - # transport is a DomainsTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def search_domains(self, - request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, - *, - location: 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, str]] = (), - ) -> domains.SearchDomainsResponse: - r"""Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - .. 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 domains_v1 - - def sample_search_domains(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = client.search_domains(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.SearchDomainsRequest, dict]): - The request object. Request for the ``SearchDomains`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Required. String used to search for - available domain names. - - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.SearchDomainsResponse: - Response for the SearchDomains method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, query]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.SearchDomainsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.SearchDomainsRequest): - request = domains.SearchDomainsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - 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_domains] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def retrieve_register_parameters(self, - request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - .. 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 domains_v1 - - def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.RetrieveRegisterParametersRequest, dict]): - The request object. Request for the ``RetrieveRegisterParameters`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (str): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.RetrieveRegisterParametersResponse: - Response for the RetrieveRegisterParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveRegisterParametersRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveRegisterParametersRequest): - request = domains.RetrieveRegisterParametersRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_register_parameters] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def register_domain(self, - request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - .. 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 domains_v1 - - def sample_register_domain(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.RegisterDomainRequest, dict]): - The request object. Request for the ``RegisterDomain`` method. - parent (str): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (google.cloud.domains_v1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (google.type.money_pb2.Money): - Required. Yearly price to register or - renew the domain. The value that should - be put here can be obtained from - RetrieveRegisterParameters or - SearchDomains calls. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RegisterDomainRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RegisterDomainRequest): - request = domains.RegisterDomainRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.register_domain] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def retrieve_transfer_parameters(self, - request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveTransferParametersResponse: - r"""Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - .. 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 domains_v1 - - def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.RetrieveTransferParametersRequest, dict]): - The request object. Request for the ``RetrieveTransferParameters`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (str): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.RetrieveTransferParametersResponse: - Response for the RetrieveTransferParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveTransferParametersRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveTransferParametersRequest): - request = domains.RetrieveTransferParametersRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_transfer_parameters] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def transfer_domain(self, - request: Optional[Union[domains.TransferDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - authorization_code: Optional[domains.AuthorizationCode] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - .. 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 domains_v1 - - def sample_transfer_domain(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.TransferDomainRequest, dict]): - The request object. Request for the ``TransferDomain`` method. - parent (str): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (google.cloud.domains_v1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to - import the domain's current DNS configuration from its - current registrar. Use this option only if you are sure - that the domain's current DNS service does not cease - upon transfer, as is often the case for DNS services - provided for free by the registrar. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (google.type.money_pb2.Money): - Required. Acknowledgement of the price to transfer or - renew the domain for one year. Call - ``RetrieveTransferParameters`` to obtain the price, - which you must acknowledge. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - authorization_code (google.cloud.domains_v1.types.AuthorizationCode): - The domain's transfer authorization - code. You can obtain this from the - domain's current registrar. - - This corresponds to the ``authorization_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price, authorization_code]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.TransferDomainRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.TransferDomainRequest): - request = domains.TransferDomainRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - if authorization_code is not None: - request.authorization_code = authorization_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.transfer_domain] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def list_registrations(self, - request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRegistrationsPager: - r"""Lists the ``Registration`` resources in a 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 domains_v1 - - def sample_list_registrations(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ListRegistrationsRequest, dict]): - The request object. Request for the ``ListRegistrations`` method. - parent (str): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager: - Response for the ListRegistrations method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ListRegistrationsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ListRegistrationsRequest): - request = domains.ListRegistrationsRequest(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_registrations] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListRegistrationsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_registration(self, - request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.Registration: - r"""Gets the details of a ``Registration`` 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 domains_v1 - - def sample_get_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = client.get_registration(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.GetRegistrationRequest, dict]): - The request object. Request for the ``GetRegistration`` method. - name (str): - Required. The name of the ``Registration`` to get, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.Registration: - The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.GetRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.GetRegistrationRequest): - request = domains.GetRegistrationRequest(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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_registration(self, - request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, - *, - registration: Optional[domains.Registration] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - .. 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 domains_v1 - - def sample_update_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.UpdateRegistrationRequest, dict]): - The request object. Request for the ``UpdateRegistration`` method. - registration (google.cloud.domains_v1.types.Registration): - Fields of the ``Registration`` to update. - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the labels are being updated, the ``update_mask`` is - ``"labels"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.UpdateRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.UpdateRegistrationRequest): - request = domains.UpdateRegistrationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - 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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration.name", request.registration.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_management_settings(self, - request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - management_settings: Optional[domains.ManagementSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s management settings. - - .. 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 domains_v1 - - def sample_configure_management_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ConfigureManagementSettingsRequest, dict]): - The request object. Request for the ``ConfigureManagementSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose - management settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - management_settings (google.cloud.domains_v1.types.ManagementSettings): - Fields of the ``ManagementSettings`` to update. - This corresponds to the ``management_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the transfer lock is being updated, the ``update_mask`` - is ``"transfer_lock_state"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, management_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureManagementSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureManagementSettingsRequest): - request = domains.ConfigureManagementSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if management_settings is not None: - request.management_settings = management_settings - 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.configure_management_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_dns_settings(self, - request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - dns_settings: Optional[domains.DnsSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s DNS settings. - - .. 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 domains_v1 - - def sample_configure_dns_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ConfigureDnsSettingsRequest, dict]): - The request object. Request for the ``ConfigureDnsSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - dns_settings (google.cloud.domains_v1.types.DnsSettings): - Fields of the ``DnsSettings`` to update. - This corresponds to the ``dns_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the name servers are being updated for an existing - Custom DNS configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains - DNS configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, dns_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureDnsSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureDnsSettingsRequest): - request = domains.ConfigureDnsSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if dns_settings is not None: - request.dns_settings = dns_settings - 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.configure_dns_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_contact_settings(self, - request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - contact_settings: Optional[domains.ContactSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - .. 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 domains_v1 - - def sample_configure_contact_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ConfigureContactSettingsRequest, dict]): - The request object. Request for the ``ConfigureContactSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact_settings (google.cloud.domains_v1.types.ContactSettings): - Fields of the ``ContactSettings`` to update. - This corresponds to the ``contact_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the registrant contact is being updated, the - ``update_mask`` is ``"registrant_contact"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, contact_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureContactSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureContactSettingsRequest): - request = domains.ConfigureContactSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if contact_settings is not None: - request.contact_settings = contact_settings - 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.configure_contact_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def export_registration(self, - request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1 - - def sample_export_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ExportRegistrationRequest, dict]): - The request object. Request for the ``ExportRegistration`` method. - name (str): - Required. The name of the ``Registration`` to export, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ExportRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ExportRegistrationRequest): - request = domains.ExportRegistrationRequest(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.export_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def delete_registration(self, - request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1 - - def sample_delete_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.DeleteRegistrationRequest, dict]): - The request object. Request for the ``DeleteRegistration`` method. - name (str): - Required. The name of the ``Registration`` to delete, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.DeleteRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.DeleteRegistrationRequest): - request = domains.DeleteRegistrationRequest(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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - empty_pb2.Empty, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def retrieve_authorization_code(self, - request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1 - - def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest, dict]): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveAuthorizationCodeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveAuthorizationCodeRequest): - request = domains.RetrieveAuthorizationCodeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_authorization_code] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def reset_authorization_code(self, - request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1 - - def sample_reset_authorization_code(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.reset_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1.types.ResetAuthorizationCodeRequest, dict]): - The request object. Request for the ``ResetAuthorizationCode`` method. - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ResetAuthorizationCodeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ResetAuthorizationCodeRequest): - request = domains.ResetAuthorizationCodeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.reset_authorization_code] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "DomainsClient": - 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__) - - -__all__ = ( - "DomainsClient", -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py deleted file mode 100644 index b29d0e6..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/pagers.py +++ /dev/null @@ -1,139 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.domains_v1.types import domains - - -class ListRegistrationsPager: - """A pager for iterating through ``list_registrations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``registrations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRegistrations`` requests and continue to iterate - through the ``registrations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` - 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[..., domains.ListRegistrationsResponse], - request: domains.ListRegistrationsRequest, - response: domains.ListRegistrationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.domains_v1.types.ListRegistrationsRequest): - The initial request object. - response (google.cloud.domains_v1.types.ListRegistrationsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = domains.ListRegistrationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[domains.ListRegistrationsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[domains.Registration]: - for page in self.pages: - yield from page.registrations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRegistrationsAsyncPager: - """A pager for iterating through ``list_registrations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``registrations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRegistrations`` requests and continue to iterate - through the ``registrations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.domains_v1.types.ListRegistrationsResponse` - 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[domains.ListRegistrationsResponse]], - request: domains.ListRegistrationsRequest, - response: domains.ListRegistrationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.domains_v1.types.ListRegistrationsRequest): - The initial request object. - response (google.cloud.domains_v1.types.ListRegistrationsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = domains.ListRegistrationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[domains.ListRegistrationsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[domains.Registration]: - async def async_generator(): - async for page in self.pages: - for response in page.registrations: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py deleted file mode 100644 index 8648a03..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import DomainsTransport -from .grpc import DomainsGrpcTransport -from .grpc_asyncio import DomainsGrpcAsyncIOTransport -from .rest import DomainsRestTransport -from .rest import DomainsRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[DomainsTransport]] -_transport_registry['grpc'] = DomainsGrpcTransport -_transport_registry['grpc_asyncio'] = DomainsGrpcAsyncIOTransport -_transport_registry['rest'] = DomainsRestTransport - -__all__ = ( - 'DomainsTransport', - 'DomainsGrpcTransport', - 'DomainsGrpcAsyncIOTransport', - 'DomainsRestTransport', - 'DomainsRestInterceptor', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py deleted file mode 100644 index a354941..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/base.py +++ /dev/null @@ -1,351 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union - -from google.cloud.domains_v1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.domains_v1.types import domains -from google.longrunning import operations_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class DomainsTransport(abc.ABC): - """Abstract transport class for Domains.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'domains.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.search_domains: gapic_v1.method.wrap_method( - self.search_domains, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_register_parameters: gapic_v1.method.wrap_method( - self.retrieve_register_parameters, - default_timeout=None, - client_info=client_info, - ), - self.register_domain: gapic_v1.method.wrap_method( - self.register_domain, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_transfer_parameters: gapic_v1.method.wrap_method( - self.retrieve_transfer_parameters, - default_timeout=None, - client_info=client_info, - ), - self.transfer_domain: gapic_v1.method.wrap_method( - self.transfer_domain, - default_timeout=None, - client_info=client_info, - ), - self.list_registrations: gapic_v1.method.wrap_method( - self.list_registrations, - default_timeout=None, - client_info=client_info, - ), - self.get_registration: gapic_v1.method.wrap_method( - self.get_registration, - default_timeout=None, - client_info=client_info, - ), - self.update_registration: gapic_v1.method.wrap_method( - self.update_registration, - default_timeout=None, - client_info=client_info, - ), - self.configure_management_settings: gapic_v1.method.wrap_method( - self.configure_management_settings, - default_timeout=None, - client_info=client_info, - ), - self.configure_dns_settings: gapic_v1.method.wrap_method( - self.configure_dns_settings, - default_timeout=None, - client_info=client_info, - ), - self.configure_contact_settings: gapic_v1.method.wrap_method( - self.configure_contact_settings, - default_timeout=None, - client_info=client_info, - ), - self.export_registration: gapic_v1.method.wrap_method( - self.export_registration, - default_timeout=None, - client_info=client_info, - ), - self.delete_registration: gapic_v1.method.wrap_method( - self.delete_registration, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_authorization_code: gapic_v1.method.wrap_method( - self.retrieve_authorization_code, - default_timeout=None, - client_info=client_info, - ), - self.reset_authorization_code: gapic_v1.method.wrap_method( - self.reset_authorization_code, - default_timeout=None, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def operations_client(self): - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - Union[ - domains.SearchDomainsResponse, - Awaitable[domains.SearchDomainsResponse] - ]]: - raise NotImplementedError() - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - Union[ - domains.RetrieveRegisterParametersResponse, - Awaitable[domains.RetrieveRegisterParametersResponse] - ]]: - raise NotImplementedError() - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - Union[ - domains.RetrieveTransferParametersResponse, - Awaitable[domains.RetrieveTransferParametersResponse] - ]]: - raise NotImplementedError() - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - Union[ - domains.ListRegistrationsResponse, - Awaitable[domains.ListRegistrationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - Union[ - domains.Registration, - Awaitable[domains.Registration] - ]]: - raise NotImplementedError() - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - Union[ - domains.AuthorizationCode, - Awaitable[domains.AuthorizationCode] - ]]: - raise NotImplementedError() - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - Union[ - domains.AuthorizationCode, - Awaitable[domains.AuthorizationCode] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'DomainsTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py deleted file mode 100644 index 90a617c..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc.py +++ /dev/null @@ -1,742 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import operations_v1 -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.domains_v1.types import domains -from google.longrunning import operations_pb2 # type: ignore -from .base import DomainsTransport, DEFAULT_CLIENT_INFO - - -class DomainsGrpcTransport(DomainsTransport): - """gRPC backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client: Optional[operations_v1.OperationsClient] = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - domains.SearchDomainsResponse]: - r"""Return a callable for the search domains method over gRPC. - - Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - Returns: - Callable[[~.SearchDomainsRequest], - ~.SearchDomainsResponse]: - 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_domains' not in self._stubs: - self._stubs['search_domains'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/SearchDomains', - request_serializer=domains.SearchDomainsRequest.serialize, - response_deserializer=domains.SearchDomainsResponse.deserialize, - ) - return self._stubs['search_domains'] - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - domains.RetrieveRegisterParametersResponse]: - r"""Return a callable for the retrieve register parameters method over gRPC. - - Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - Returns: - Callable[[~.RetrieveRegisterParametersRequest], - ~.RetrieveRegisterParametersResponse]: - 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 'retrieve_register_parameters' not in self._stubs: - self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveRegisterParameters', - request_serializer=domains.RetrieveRegisterParametersRequest.serialize, - response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, - ) - return self._stubs['retrieve_register_parameters'] - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - operations_pb2.Operation]: - r"""Return a callable for the register domain method over gRPC. - - Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - Returns: - Callable[[~.RegisterDomainRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_domain' not in self._stubs: - self._stubs['register_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RegisterDomain', - request_serializer=domains.RegisterDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['register_domain'] - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - domains.RetrieveTransferParametersResponse]: - r"""Return a callable for the retrieve transfer parameters method over gRPC. - - Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - Returns: - Callable[[~.RetrieveTransferParametersRequest], - ~.RetrieveTransferParametersResponse]: - 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 'retrieve_transfer_parameters' not in self._stubs: - self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveTransferParameters', - request_serializer=domains.RetrieveTransferParametersRequest.serialize, - response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, - ) - return self._stubs['retrieve_transfer_parameters'] - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - operations_pb2.Operation]: - r"""Return a callable for the transfer domain method over gRPC. - - Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - Returns: - Callable[[~.TransferDomainRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'transfer_domain' not in self._stubs: - self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/TransferDomain', - request_serializer=domains.TransferDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['transfer_domain'] - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - domains.ListRegistrationsResponse]: - r"""Return a callable for the list registrations method over gRPC. - - Lists the ``Registration`` resources in a project. - - Returns: - Callable[[~.ListRegistrationsRequest], - ~.ListRegistrationsResponse]: - 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_registrations' not in self._stubs: - self._stubs['list_registrations'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ListRegistrations', - request_serializer=domains.ListRegistrationsRequest.serialize, - response_deserializer=domains.ListRegistrationsResponse.deserialize, - ) - return self._stubs['list_registrations'] - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - domains.Registration]: - r"""Return a callable for the get registration method over gRPC. - - Gets the details of a ``Registration`` resource. - - Returns: - Callable[[~.GetRegistrationRequest], - ~.Registration]: - 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_registration' not in self._stubs: - self._stubs['get_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/GetRegistration', - request_serializer=domains.GetRegistrationRequest.serialize, - response_deserializer=domains.Registration.deserialize, - ) - return self._stubs['get_registration'] - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the update registration method over gRPC. - - Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - Returns: - Callable[[~.UpdateRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_registration' not in self._stubs: - self._stubs['update_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/UpdateRegistration', - request_serializer=domains.UpdateRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_registration'] - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure management settings method over gRPC. - - Updates a ``Registration``'s management settings. - - Returns: - Callable[[~.ConfigureManagementSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_management_settings' not in self._stubs: - self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureManagementSettings', - request_serializer=domains.ConfigureManagementSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_management_settings'] - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure dns settings method over gRPC. - - Updates a ``Registration``'s DNS settings. - - Returns: - Callable[[~.ConfigureDnsSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_dns_settings' not in self._stubs: - self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureDnsSettings', - request_serializer=domains.ConfigureDnsSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_dns_settings'] - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure contact settings method over gRPC. - - Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - Returns: - Callable[[~.ConfigureContactSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_contact_settings' not in self._stubs: - self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureContactSettings', - request_serializer=domains.ConfigureContactSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_contact_settings'] - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the export registration method over gRPC. - - Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.ExportRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'export_registration' not in self._stubs: - self._stubs['export_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ExportRegistration', - request_serializer=domains.ExportRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['export_registration'] - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete registration method over gRPC. - - Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.DeleteRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_registration' not in self._stubs: - self._stubs['delete_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/DeleteRegistration', - request_serializer=domains.DeleteRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_registration'] - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - domains.AuthorizationCode]: - r"""Return a callable for the retrieve authorization code method over gRPC. - - Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.RetrieveAuthorizationCodeRequest], - ~.AuthorizationCode]: - 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 'retrieve_authorization_code' not in self._stubs: - self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveAuthorizationCode', - request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['retrieve_authorization_code'] - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - domains.AuthorizationCode]: - r"""Return a callable for the reset authorization code method over gRPC. - - Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.ResetAuthorizationCodeRequest], - ~.AuthorizationCode]: - 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 'reset_authorization_code' not in self._stubs: - self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ResetAuthorizationCode', - request_serializer=domains.ResetAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['reset_authorization_code'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'DomainsGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py deleted file mode 100644 index a6c305f..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/grpc_asyncio.py +++ /dev/null @@ -1,741 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.domains_v1.types import domains -from google.longrunning import operations_pb2 # type: ignore -from .base import DomainsTransport, DEFAULT_CLIENT_INFO -from .grpc import DomainsGrpcTransport - - -class DomainsGrpcAsyncIOTransport(DomainsTransport): - """gRPC AsyncIO backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsAsyncClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsAsyncClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - Awaitable[domains.SearchDomainsResponse]]: - r"""Return a callable for the search domains method over gRPC. - - Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - Returns: - Callable[[~.SearchDomainsRequest], - Awaitable[~.SearchDomainsResponse]]: - 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_domains' not in self._stubs: - self._stubs['search_domains'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/SearchDomains', - request_serializer=domains.SearchDomainsRequest.serialize, - response_deserializer=domains.SearchDomainsResponse.deserialize, - ) - return self._stubs['search_domains'] - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - Awaitable[domains.RetrieveRegisterParametersResponse]]: - r"""Return a callable for the retrieve register parameters method over gRPC. - - Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - Returns: - Callable[[~.RetrieveRegisterParametersRequest], - Awaitable[~.RetrieveRegisterParametersResponse]]: - 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 'retrieve_register_parameters' not in self._stubs: - self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveRegisterParameters', - request_serializer=domains.RetrieveRegisterParametersRequest.serialize, - response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, - ) - return self._stubs['retrieve_register_parameters'] - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the register domain method over gRPC. - - Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - Returns: - Callable[[~.RegisterDomainRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_domain' not in self._stubs: - self._stubs['register_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RegisterDomain', - request_serializer=domains.RegisterDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['register_domain'] - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - Awaitable[domains.RetrieveTransferParametersResponse]]: - r"""Return a callable for the retrieve transfer parameters method over gRPC. - - Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - Returns: - Callable[[~.RetrieveTransferParametersRequest], - Awaitable[~.RetrieveTransferParametersResponse]]: - 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 'retrieve_transfer_parameters' not in self._stubs: - self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveTransferParameters', - request_serializer=domains.RetrieveTransferParametersRequest.serialize, - response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, - ) - return self._stubs['retrieve_transfer_parameters'] - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the transfer domain method over gRPC. - - Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - Returns: - Callable[[~.TransferDomainRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'transfer_domain' not in self._stubs: - self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/TransferDomain', - request_serializer=domains.TransferDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['transfer_domain'] - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - Awaitable[domains.ListRegistrationsResponse]]: - r"""Return a callable for the list registrations method over gRPC. - - Lists the ``Registration`` resources in a project. - - Returns: - Callable[[~.ListRegistrationsRequest], - Awaitable[~.ListRegistrationsResponse]]: - 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_registrations' not in self._stubs: - self._stubs['list_registrations'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ListRegistrations', - request_serializer=domains.ListRegistrationsRequest.serialize, - response_deserializer=domains.ListRegistrationsResponse.deserialize, - ) - return self._stubs['list_registrations'] - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - Awaitable[domains.Registration]]: - r"""Return a callable for the get registration method over gRPC. - - Gets the details of a ``Registration`` resource. - - Returns: - Callable[[~.GetRegistrationRequest], - Awaitable[~.Registration]]: - 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_registration' not in self._stubs: - self._stubs['get_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/GetRegistration', - request_serializer=domains.GetRegistrationRequest.serialize, - response_deserializer=domains.Registration.deserialize, - ) - return self._stubs['get_registration'] - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the update registration method over gRPC. - - Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - Returns: - Callable[[~.UpdateRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_registration' not in self._stubs: - self._stubs['update_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/UpdateRegistration', - request_serializer=domains.UpdateRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_registration'] - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure management settings method over gRPC. - - Updates a ``Registration``'s management settings. - - Returns: - Callable[[~.ConfigureManagementSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_management_settings' not in self._stubs: - self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureManagementSettings', - request_serializer=domains.ConfigureManagementSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_management_settings'] - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure dns settings method over gRPC. - - Updates a ``Registration``'s DNS settings. - - Returns: - Callable[[~.ConfigureDnsSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_dns_settings' not in self._stubs: - self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureDnsSettings', - request_serializer=domains.ConfigureDnsSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_dns_settings'] - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure contact settings method over gRPC. - - Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - Returns: - Callable[[~.ConfigureContactSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_contact_settings' not in self._stubs: - self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ConfigureContactSettings', - request_serializer=domains.ConfigureContactSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_contact_settings'] - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the export registration method over gRPC. - - Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.ExportRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'export_registration' not in self._stubs: - self._stubs['export_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ExportRegistration', - request_serializer=domains.ExportRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['export_registration'] - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete registration method over gRPC. - - Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.DeleteRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_registration' not in self._stubs: - self._stubs['delete_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/DeleteRegistration', - request_serializer=domains.DeleteRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_registration'] - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - Awaitable[domains.AuthorizationCode]]: - r"""Return a callable for the retrieve authorization code method over gRPC. - - Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.RetrieveAuthorizationCodeRequest], - Awaitable[~.AuthorizationCode]]: - 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 'retrieve_authorization_code' not in self._stubs: - self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/RetrieveAuthorizationCode', - request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['retrieve_authorization_code'] - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - Awaitable[domains.AuthorizationCode]]: - r"""Return a callable for the reset authorization code method over gRPC. - - Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.ResetAuthorizationCodeRequest], - Awaitable[~.AuthorizationCode]]: - 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 'reset_authorization_code' not in self._stubs: - self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1.Domains/ResetAuthorizationCode', - request_serializer=domains.ResetAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['reset_authorization_code'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'DomainsGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py b/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py deleted file mode 100644 index 7b20c71..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/services/domains/transports/rest.py +++ /dev/null @@ -1,1976 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from google.api_core import operations_v1 -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - - -from google.cloud.domains_v1.types import domains -from google.longrunning import operations_pb2 # type: ignore - -from .base import DomainsTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class DomainsRestInterceptor: - """Interceptor for Domains. - - 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 DomainsRestTransport. - - .. code-block:: python - class MyCustomDomainsInterceptor(DomainsRestInterceptor): - def pre_configure_contact_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_contact_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_configure_dns_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_dns_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_configure_management_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_management_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_delete_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_export_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_export_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_registrations(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_registrations(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_domain(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_domain(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_reset_authorization_code(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_reset_authorization_code(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_authorization_code(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_authorization_code(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_register_parameters(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_register_parameters(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_transfer_parameters(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_transfer_parameters(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_search_domains(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_search_domains(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_transfer_domain(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_transfer_domain(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_registration(self, response): - logging.log(f"Received response: {response}") - return response - - transport = DomainsRestTransport(interceptor=MyCustomDomainsInterceptor()) - client = DomainsClient(transport=transport) - - - """ - def pre_configure_contact_settings(self, request: domains.ConfigureContactSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureContactSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_contact_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_contact_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_contact_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_configure_dns_settings(self, request: domains.ConfigureDnsSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureDnsSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_dns_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_dns_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_dns_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_configure_management_settings(self, request: domains.ConfigureManagementSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureManagementSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_management_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_management_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_management_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_delete_registration(self, request: domains.DeleteRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.DeleteRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_delete_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for delete_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_export_registration(self, request: domains.ExportRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ExportRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for export_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_export_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for export_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_get_registration(self, request: domains.GetRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.GetRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_get_registration(self, response: domains.Registration) -> domains.Registration: - """Post-rpc interceptor for get_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_list_registrations(self, request: domains.ListRegistrationsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ListRegistrationsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_registrations - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_list_registrations(self, response: domains.ListRegistrationsResponse) -> domains.ListRegistrationsResponse: - """Post-rpc interceptor for list_registrations - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_register_domain(self, request: domains.RegisterDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RegisterDomainRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_domain - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_register_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for register_domain - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_reset_authorization_code(self, request: domains.ResetAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ResetAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for reset_authorization_code - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_reset_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: - """Post-rpc interceptor for reset_authorization_code - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_authorization_code(self, request: domains.RetrieveAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_authorization_code - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: - """Post-rpc interceptor for retrieve_authorization_code - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_register_parameters(self, request: domains.RetrieveRegisterParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveRegisterParametersRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_register_parameters - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_register_parameters(self, response: domains.RetrieveRegisterParametersResponse) -> domains.RetrieveRegisterParametersResponse: - """Post-rpc interceptor for retrieve_register_parameters - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_transfer_parameters(self, request: domains.RetrieveTransferParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveTransferParametersRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_transfer_parameters - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_transfer_parameters(self, response: domains.RetrieveTransferParametersResponse) -> domains.RetrieveTransferParametersResponse: - """Post-rpc interceptor for retrieve_transfer_parameters - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_search_domains(self, request: domains.SearchDomainsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.SearchDomainsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for search_domains - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_search_domains(self, response: domains.SearchDomainsResponse) -> domains.SearchDomainsResponse: - """Post-rpc interceptor for search_domains - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_transfer_domain(self, request: domains.TransferDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.TransferDomainRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for transfer_domain - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_transfer_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for transfer_domain - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_update_registration(self, request: domains.UpdateRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.UpdateRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_update_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for update_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class DomainsRestStub: - _session: AuthorizedSession - _host: str - _interceptor: DomainsRestInterceptor - - -class DomainsRestTransport(DomainsTransport): - """REST backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.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[DomainsRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or DomainsRestInterceptor() - self._prep_wrapped_messages(client_info) - - @property - def operations_client(self) -> operations_v1.AbstractOperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Only create a new client if we do not already have one. - if self._operations_client is None: - http_options: Dict[str, List[Dict[str, str]]] = { - 'google.longrunning.Operations.GetOperation': [ - { - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.ListOperations': [ - { - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*}/operations', - }, - ], - } - - rest_transport = operations_v1.OperationsRestTransport( - host=self._host, - # use the credentials which are saved - credentials=self._credentials, - scopes=self._scopes, - http_options=http_options, - path_prefix="v1") - - self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) - - # Return the client from cache. - return self._operations_client - - class _ConfigureContactSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureContactSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureContactSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure contact - settings method over HTTP. - - Args: - request (~.domains.ConfigureContactSettingsRequest): - The request object. Request for the ``ConfigureContactSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_contact_settings(request, metadata) - pb_request = domains.ConfigureContactSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_contact_settings(resp) - return resp - - class _ConfigureDnsSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureDnsSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureDnsSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure dns settings method over HTTP. - - Args: - request (~.domains.ConfigureDnsSettingsRequest): - The request object. Request for the ``ConfigureDnsSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_dns_settings(request, metadata) - pb_request = domains.ConfigureDnsSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_dns_settings(resp) - return resp - - class _ConfigureManagementSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureManagementSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureManagementSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure management - settings method over HTTP. - - Args: - request (~.domains.ConfigureManagementSettingsRequest): - The request object. Request for the ``ConfigureManagementSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_management_settings(request, metadata) - pb_request = domains.ConfigureManagementSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_management_settings(resp) - return resp - - class _DeleteRegistration(DomainsRestStub): - def __hash__(self): - return hash("DeleteRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.DeleteRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the delete registration method over HTTP. - - Args: - request (~.domains.DeleteRegistrationRequest): - The request object. Request for the ``DeleteRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/locations/*/registrations/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_registration(request, metadata) - pb_request = domains.DeleteRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_delete_registration(resp) - return resp - - class _ExportRegistration(DomainsRestStub): - def __hash__(self): - return hash("ExportRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ExportRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the export registration method over HTTP. - - Args: - request (~.domains.ExportRegistrationRequest): - The request object. Request for the ``ExportRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{name=projects/*/locations/*/registrations/*}:export', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_export_registration(request, metadata) - pb_request = domains.ExportRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_export_registration(resp) - return resp - - class _GetRegistration(DomainsRestStub): - def __hash__(self): - return hash("GetRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.GetRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.Registration: - r"""Call the get registration method over HTTP. - - Args: - request (~.domains.GetRegistrationRequest): - The request object. Request for the ``GetRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.Registration: - The ``Registration`` resource facilitates managing and - configuring domain name registrations. - - There are several ways to create a new ``Registration`` - resource: - - To create a new ``Registration`` resource, find a - suitable domain name by calling the ``SearchDomains`` - method with a query to see available domain name - options. After choosing a name, call - ``RetrieveRegisterParameters`` to ensure availability - and obtain information like pricing, which is needed to - build a call to ``RegisterDomain``. - - Another way to create a new ``Registration`` is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the domain - for transfer and retrieve the domain's transfer - authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the - domain is unlocked and to get values needed to build a - call to ``TransferDomain``. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/registrations/*}', - }, - ] - request, metadata = self._interceptor.pre_get_registration(request, metadata) - pb_request = domains.GetRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.Registration() - pb_resp = domains.Registration.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_registration(resp) - return resp - - class _ListRegistrations(DomainsRestStub): - def __hash__(self): - return hash("ListRegistrations") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ListRegistrationsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.ListRegistrationsResponse: - r"""Call the list registrations method over HTTP. - - Args: - request (~.domains.ListRegistrationsRequest): - The request object. Request for the ``ListRegistrations`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.ListRegistrationsResponse: - Response for the ``ListRegistrations`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}/registrations', - }, - ] - request, metadata = self._interceptor.pre_list_registrations(request, metadata) - pb_request = domains.ListRegistrationsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.ListRegistrationsResponse() - pb_resp = domains.ListRegistrationsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_registrations(resp) - return resp - - class _RegisterDomain(DomainsRestStub): - def __hash__(self): - return hash("RegisterDomain") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RegisterDomainRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the register domain method over HTTP. - - Args: - request (~.domains.RegisterDomainRequest): - The request object. Request for the ``RegisterDomain`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/registrations:register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_domain(request, metadata) - pb_request = domains.RegisterDomainRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_domain(resp) - return resp - - class _ResetAuthorizationCode(DomainsRestStub): - def __hash__(self): - return hash("ResetAuthorizationCode") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ResetAuthorizationCodeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.AuthorizationCode: - r"""Call the reset authorization code method over HTTP. - - Args: - request (~.domains.ResetAuthorizationCodeRequest): - The request object. Request for the ``ResetAuthorizationCode`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.AuthorizationCode: - Defines an authorization code. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_reset_authorization_code(request, metadata) - pb_request = domains.ResetAuthorizationCodeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.AuthorizationCode() - pb_resp = domains.AuthorizationCode.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_reset_authorization_code(resp) - return resp - - class _RetrieveAuthorizationCode(DomainsRestStub): - def __hash__(self): - return hash("RetrieveAuthorizationCode") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveAuthorizationCodeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.AuthorizationCode: - r"""Call the retrieve authorization - code method over HTTP. - - Args: - request (~.domains.RetrieveAuthorizationCodeRequest): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.AuthorizationCode: - Defines an authorization code. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode', - }, - ] - request, metadata = self._interceptor.pre_retrieve_authorization_code(request, metadata) - pb_request = domains.RetrieveAuthorizationCodeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.AuthorizationCode() - pb_resp = domains.AuthorizationCode.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_authorization_code(resp) - return resp - - class _RetrieveRegisterParameters(DomainsRestStub): - def __hash__(self): - return hash("RetrieveRegisterParameters") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "domainName" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveRegisterParametersRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Call the retrieve register - parameters method over HTTP. - - Args: - request (~.domains.RetrieveRegisterParametersRequest): - The request object. Request for the ``RetrieveRegisterParameters`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.RetrieveRegisterParametersResponse: - Response for the ``RetrieveRegisterParameters`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters', - }, - ] - request, metadata = self._interceptor.pre_retrieve_register_parameters(request, metadata) - pb_request = domains.RetrieveRegisterParametersRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.RetrieveRegisterParametersResponse() - pb_resp = domains.RetrieveRegisterParametersResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_register_parameters(resp) - return resp - - class _RetrieveTransferParameters(DomainsRestStub): - def __hash__(self): - return hash("RetrieveTransferParameters") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "domainName" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveTransferParametersRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.RetrieveTransferParametersResponse: - r"""Call the retrieve transfer - parameters method over HTTP. - - Args: - request (~.domains.RetrieveTransferParametersRequest): - The request object. Request for the ``RetrieveTransferParameters`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.RetrieveTransferParametersResponse: - Response for the ``RetrieveTransferParameters`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters', - }, - ] - request, metadata = self._interceptor.pre_retrieve_transfer_parameters(request, metadata) - pb_request = domains.RetrieveTransferParametersRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.RetrieveTransferParametersResponse() - pb_resp = domains.RetrieveTransferParametersResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_transfer_parameters(resp) - return resp - - class _SearchDomains(DomainsRestStub): - def __hash__(self): - return hash("SearchDomains") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "query" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.SearchDomainsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.SearchDomainsResponse: - r"""Call the search domains method over HTTP. - - Args: - request (~.domains.SearchDomainsRequest): - The request object. Request for the ``SearchDomains`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.SearchDomainsResponse: - Response for the ``SearchDomains`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{location=projects/*/locations/*}/registrations:searchDomains', - }, - ] - request, metadata = self._interceptor.pre_search_domains(request, metadata) - pb_request = domains.SearchDomainsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.SearchDomainsResponse() - pb_resp = domains.SearchDomainsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_search_domains(resp) - return resp - - class _TransferDomain(DomainsRestStub): - def __hash__(self): - return hash("TransferDomain") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.TransferDomainRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the transfer domain method over HTTP. - - Args: - request (~.domains.TransferDomainRequest): - The request object. Request for the ``TransferDomain`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/registrations:transfer', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_transfer_domain(request, metadata) - pb_request = domains.TransferDomainRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_transfer_domain(resp) - return resp - - class _UpdateRegistration(DomainsRestStub): - def __hash__(self): - return hash("UpdateRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "updateMask" : {}, } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.UpdateRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the update registration method over HTTP. - - Args: - request (~.domains.UpdateRegistrationRequest): - The request object. Request for the ``UpdateRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{registration.name=projects/*/locations/*/registrations/*}', - 'body': 'registration', - }, - ] - request, metadata = self._interceptor.pre_update_registration(request, metadata) - pb_request = domains.UpdateRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_registration(resp) - return resp - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureContactSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureDnsSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureManagementSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ExportRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - domains.Registration]: - # 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._GetRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - domains.ListRegistrationsResponse]: - # 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._ListRegistrations(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDomain(self._session, self._host, self._interceptor) # type: ignore - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - domains.AuthorizationCode]: - # 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._ResetAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - domains.AuthorizationCode]: - # 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._RetrieveAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - domains.RetrieveRegisterParametersResponse]: - # 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._RetrieveRegisterParameters(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - domains.RetrieveTransferParametersResponse]: - # 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._RetrieveTransferParameters(self._session, self._host, self._interceptor) # type: ignore - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - domains.SearchDomainsResponse]: - # 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._SearchDomains(self._session, self._host, self._interceptor) # type: ignore - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._TransferDomain(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'DomainsRestTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py deleted file mode 100644 index cb45e82..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/types/__init__.py +++ /dev/null @@ -1,82 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .domains import ( - AuthorizationCode, - ConfigureContactSettingsRequest, - ConfigureDnsSettingsRequest, - ConfigureManagementSettingsRequest, - ContactSettings, - DeleteRegistrationRequest, - DnsSettings, - ExportRegistrationRequest, - GetRegistrationRequest, - ListRegistrationsRequest, - ListRegistrationsResponse, - ManagementSettings, - OperationMetadata, - RegisterDomainRequest, - RegisterParameters, - Registration, - ResetAuthorizationCodeRequest, - RetrieveAuthorizationCodeRequest, - RetrieveRegisterParametersRequest, - RetrieveRegisterParametersResponse, - RetrieveTransferParametersRequest, - RetrieveTransferParametersResponse, - SearchDomainsRequest, - SearchDomainsResponse, - TransferDomainRequest, - TransferParameters, - UpdateRegistrationRequest, - ContactNotice, - ContactPrivacy, - DomainNotice, - TransferLockState, -) - -__all__ = ( - 'AuthorizationCode', - 'ConfigureContactSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureManagementSettingsRequest', - 'ContactSettings', - 'DeleteRegistrationRequest', - 'DnsSettings', - 'ExportRegistrationRequest', - 'GetRegistrationRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'ManagementSettings', - 'OperationMetadata', - 'RegisterDomainRequest', - 'RegisterParameters', - 'Registration', - 'ResetAuthorizationCodeRequest', - 'RetrieveAuthorizationCodeRequest', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'TransferDomainRequest', - 'TransferParameters', - 'UpdateRegistrationRequest', - 'ContactNotice', - 'ContactPrivacy', - 'DomainNotice', - 'TransferLockState', -) diff --git a/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py b/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py deleted file mode 100644 index a066517..0000000 --- a/owl-bot-staging/v1/google/cloud/domains_v1/types/domains.py +++ /dev/null @@ -1,1523 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from google.type import postal_address_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.domains.v1', - manifest={ - 'ContactPrivacy', - 'DomainNotice', - 'ContactNotice', - 'TransferLockState', - 'Registration', - 'ManagementSettings', - 'DnsSettings', - 'ContactSettings', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RegisterDomainRequest', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'TransferDomainRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'GetRegistrationRequest', - 'UpdateRegistrationRequest', - 'ConfigureManagementSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureContactSettingsRequest', - 'ExportRegistrationRequest', - 'DeleteRegistrationRequest', - 'RetrieveAuthorizationCodeRequest', - 'ResetAuthorizationCodeRequest', - 'RegisterParameters', - 'TransferParameters', - 'AuthorizationCode', - 'OperationMetadata', - }, -) - - -class ContactPrivacy(proto.Enum): - r"""Defines a set of possible contact privacy settings for a - ``Registration``. - - `ICANN `__ maintains the WHOIS database, a - publicly accessible mapping from domain name to contact information, - and requires that each domain name have an entry. Choose from these - options to control how much information in your ``ContactSettings`` - is published. - - Values: - CONTACT_PRIVACY_UNSPECIFIED (0): - The contact privacy settings are undefined. - PUBLIC_CONTACT_DATA (1): - All the data from ``ContactSettings`` is publicly available. - When setting this option, you must also provide a - ``PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT`` in the - ``contact_notices`` field of the request. - PRIVATE_CONTACT_DATA (2): - None of the data from ``ContactSettings`` is publicly - available. Instead, proxy contact data is published for your - domain. Email sent to the proxy email address is forwarded - to the registrant's email address. Cloud Domains provides - this privacy proxy service at no additional cost. - REDACTED_CONTACT_DATA (3): - Some data from ``ContactSettings`` is publicly available. - The actual information redacted depends on the domain. For - details, see `the registration privacy - article `__. - """ - CONTACT_PRIVACY_UNSPECIFIED = 0 - PUBLIC_CONTACT_DATA = 1 - PRIVATE_CONTACT_DATA = 2 - REDACTED_CONTACT_DATA = 3 - - -class DomainNotice(proto.Enum): - r"""Notices about special properties of certain domains. - - Values: - DOMAIN_NOTICE_UNSPECIFIED (0): - The notice is undefined. - HSTS_PRELOADED (1): - Indicates that the domain is preloaded on the HTTP Strict - Transport Security list in browsers. Serving a website on - such domain requires an SSL certificate. For details, see - `how to get an SSL - certificate `__. - """ - DOMAIN_NOTICE_UNSPECIFIED = 0 - HSTS_PRELOADED = 1 - - -class ContactNotice(proto.Enum): - r"""Notices related to contact information. - - Values: - CONTACT_NOTICE_UNSPECIFIED (0): - The notice is undefined. - PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1): - Required when setting the ``privacy`` field of - ``ContactSettings`` to ``PUBLIC_CONTACT_DATA``, which - exposes contact data publicly. - """ - CONTACT_NOTICE_UNSPECIFIED = 0 - PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT = 1 - - -class TransferLockState(proto.Enum): - r"""Possible states of a ``Registration``'s transfer lock. - - Values: - TRANSFER_LOCK_STATE_UNSPECIFIED (0): - The state is unspecified. - UNLOCKED (1): - The domain is unlocked and can be transferred - to another registrar. - LOCKED (2): - The domain is locked and cannot be - transferred to another registrar. - """ - TRANSFER_LOCK_STATE_UNSPECIFIED = 0 - UNLOCKED = 1 - LOCKED = 2 - - -class Registration(proto.Message): - r"""The ``Registration`` resource facilitates managing and configuring - domain name registrations. - - There are several ways to create a new ``Registration`` resource: - - To create a new ``Registration`` resource, find a suitable domain - name by calling the ``SearchDomains`` method with a query to see - available domain name options. After choosing a name, call - ``RetrieveRegisterParameters`` to ensure availability and obtain - information like pricing, which is needed to build a call to - ``RegisterDomain``. - - Another way to create a new ``Registration`` is to transfer an - existing domain from another registrar. First, go to the current - registrar to unlock the domain for transfer and retrieve the - domain's transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to - ``TransferDomain``. - - Attributes: - name (str): - Output only. Name of the ``Registration`` resource, in the - format - ``projects/*/locations/*/registrations/``. - domain_name (str): - Required. Immutable. The domain name. Unicode - domain names must be expressed in Punycode - format. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The creation timestamp of the ``Registration`` - resource. - expire_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The expiration timestamp of the - ``Registration``. - state (google.cloud.domains_v1.types.Registration.State): - Output only. The state of the ``Registration`` - issues (MutableSequence[google.cloud.domains_v1.types.Registration.Issue]): - Output only. The set of issues with the ``Registration`` - that require attention. - labels (MutableMapping[str, str]): - Set of labels associated with the ``Registration``. - management_settings (google.cloud.domains_v1.types.ManagementSettings): - Settings for management of the ``Registration``, including - renewal, billing, and transfer. You cannot update these with - the ``UpdateRegistration`` method. To update these settings, - use the ``ConfigureManagementSettings`` method. - dns_settings (google.cloud.domains_v1.types.DnsSettings): - Settings controlling the DNS configuration of the - ``Registration``. You cannot update these with the - ``UpdateRegistration`` method. To update these settings, use - the ``ConfigureDnsSettings`` method. - contact_settings (google.cloud.domains_v1.types.ContactSettings): - Required. Settings for contact information linked to the - ``Registration``. You cannot update these with the - ``UpdateRegistration`` method. To update these settings, use - the ``ConfigureContactSettings`` method. - pending_contact_settings (google.cloud.domains_v1.types.ContactSettings): - Output only. Pending contact settings for the - ``Registration``. Updates to the ``contact_settings`` field - that change its ``registrant_contact`` or ``privacy`` fields - require email confirmation by the ``registrant_contact`` - before taking effect. This field is set only if there are - pending updates to the ``contact_settings`` that have not - been confirmed. To confirm the changes, the - ``registrant_contact`` must follow the instructions in the - email they receive. - supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): - Output only. Set of options for the - ``contact_settings.privacy`` field that this - ``Registration`` supports. - """ - class State(proto.Enum): - r"""Possible states of a ``Registration``. - - Values: - STATE_UNSPECIFIED (0): - The state is undefined. - REGISTRATION_PENDING (1): - The domain is being registered. - REGISTRATION_FAILED (2): - The domain registration failed. You can - delete resources in this state to allow - registration to be retried. - TRANSFER_PENDING (3): - The domain is being transferred from another - registrar to Cloud Domains. - TRANSFER_FAILED (4): - The attempt to transfer the domain from - another registrar to Cloud Domains failed. You - can delete resources in this state and retry the - transfer. - ACTIVE (6): - The domain is registered and operational. The - domain renews automatically as long as it - remains in this state. - SUSPENDED (7): - The domain is suspended and inoperative. For more details, - see the ``issues`` field. - EXPORTED (8): - The domain is no longer managed with Cloud Domains. It may - have been transferred to another registrar or exported for - management in `Google Domains `__. - You can no longer update it with this API, and information - shown about it may be stale. Domains in this state are not - automatically renewed by Cloud Domains. - """ - STATE_UNSPECIFIED = 0 - REGISTRATION_PENDING = 1 - REGISTRATION_FAILED = 2 - TRANSFER_PENDING = 3 - TRANSFER_FAILED = 4 - ACTIVE = 6 - SUSPENDED = 7 - EXPORTED = 8 - - class Issue(proto.Enum): - r"""Possible issues with a ``Registration`` that require attention. - - Values: - ISSUE_UNSPECIFIED (0): - The issue is undefined. - CONTACT_SUPPORT (1): - Contact the Cloud Support team to resolve a - problem with this domain. - UNVERIFIED_EMAIL (2): - `ICANN `__ requires verification of the - email address in the ``Registration``'s - ``contact_settings.registrant_contact`` field. To verify the - email address, follow the instructions in the email the - ``registrant_contact`` receives following registration. If - you do not complete email verification within 15 days of - registration, the domain is suspended. To resend the - verification email, call ConfigureContactSettings and - provide the current ``registrant_contact.email``. - """ - ISSUE_UNSPECIFIED = 0 - CONTACT_SUPPORT = 1 - UNVERIFIED_EMAIL = 2 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - domain_name: str = proto.Field( - proto.STRING, - number=2, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - expire_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=6, - message=timestamp_pb2.Timestamp, - ) - state: State = proto.Field( - proto.ENUM, - number=7, - enum=State, - ) - issues: MutableSequence[Issue] = proto.RepeatedField( - proto.ENUM, - number=8, - enum=Issue, - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=9, - ) - management_settings: 'ManagementSettings' = proto.Field( - proto.MESSAGE, - number=10, - message='ManagementSettings', - ) - dns_settings: 'DnsSettings' = proto.Field( - proto.MESSAGE, - number=11, - message='DnsSettings', - ) - contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=12, - message='ContactSettings', - ) - pending_contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=13, - message='ContactSettings', - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=14, - enum='ContactPrivacy', - ) - - -class ManagementSettings(proto.Message): - r"""Defines renewal, billing, and transfer settings for a - ``Registration``. - - Attributes: - renewal_method (google.cloud.domains_v1.types.ManagementSettings.RenewalMethod): - Output only. The renewal method for this ``Registration``. - transfer_lock_state (google.cloud.domains_v1.types.TransferLockState): - Controls whether the domain can be - transferred to another registrar. - """ - class RenewalMethod(proto.Enum): - r"""Defines how the ``Registration`` is renewed. - - Values: - RENEWAL_METHOD_UNSPECIFIED (0): - The renewal method is undefined. - AUTOMATIC_RENEWAL (1): - The domain is automatically renewed each year . - - To disable automatic renewals, delete the resource by - calling ``DeleteRegistration`` or export it by calling - ``ExportRegistration``. - MANUAL_RENEWAL (2): - The domain must be explicitly renewed each year before its - ``expire_time``. This option is only available when the - ``Registration`` is in state ``EXPORTED``. - - To manage the domain's current billing and renewal settings, - go to `Google Domains `__. - """ - RENEWAL_METHOD_UNSPECIFIED = 0 - AUTOMATIC_RENEWAL = 1 - MANUAL_RENEWAL = 2 - - renewal_method: RenewalMethod = proto.Field( - proto.ENUM, - number=3, - enum=RenewalMethod, - ) - transfer_lock_state: 'TransferLockState' = proto.Field( - proto.ENUM, - number=4, - enum='TransferLockState', - ) - - -class DnsSettings(proto.Message): - r"""Defines the DNS configuration of a ``Registration``, including name - servers, DNSSEC, and glue records. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - custom_dns (google.cloud.domains_v1.types.DnsSettings.CustomDns): - An arbitrary DNS provider identified by its - name servers. - - This field is a member of `oneof`_ ``dns_provider``. - google_domains_dns (google.cloud.domains_v1.types.DnsSettings.GoogleDomainsDns): - The free DNS zone provided by `Google - Domains `__. - - This field is a member of `oneof`_ ``dns_provider``. - glue_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.GlueRecord]): - The list of glue records for this ``Registration``. Commonly - empty. - """ - class DsState(proto.Enum): - r"""The publication state of DS records for a ``Registration``. - - Values: - DS_STATE_UNSPECIFIED (0): - DS state is unspecified. - DS_RECORDS_UNPUBLISHED (1): - DNSSEC is disabled for this domain. No DS - records for this domain are published in the - parent DNS zone. - DS_RECORDS_PUBLISHED (2): - DNSSEC is enabled for this domain. Appropriate DS records - for this domain are published in the parent DNS zone. This - option is valid only if the DNS zone referenced in the - ``Registration``'s ``dns_provider`` field is already - DNSSEC-signed. - """ - DS_STATE_UNSPECIFIED = 0 - DS_RECORDS_UNPUBLISHED = 1 - DS_RECORDS_PUBLISHED = 2 - - class CustomDns(proto.Message): - r"""Configuration for an arbitrary DNS provider. - - Attributes: - name_servers (MutableSequence[str]): - Required. A list of name servers that store - the DNS zone for this domain. Each name server - is a domain name, with Unicode domain names - expressed in Punycode format. - ds_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]): - The list of DS records for this domain, which - are used to enable DNSSEC. The domain's DNS - provider can provide the values to set here. If - this field is empty, DNSSEC is disabled. - """ - - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='DnsSettings.DsRecord', - ) - - class GoogleDomainsDns(proto.Message): - r"""Configuration for using the free DNS zone provided by Google Domains - as a ``Registration``'s ``dns_provider``. You cannot configure the - DNS zone itself using the API. To configure the DNS zone, go to - `Google Domains `__. - - Attributes: - name_servers (MutableSequence[str]): - Output only. A list of name servers that - store the DNS zone for this domain. Each name - server is a domain name, with Unicode domain - names expressed in Punycode format. This field - is automatically populated with the name servers - assigned to the Google Domains DNS zone. - ds_state (google.cloud.domains_v1.types.DnsSettings.DsState): - Required. The state of DS records for this - domain. Used to enable or disable automatic - DNSSEC. - ds_records (MutableSequence[google.cloud.domains_v1.types.DnsSettings.DsRecord]): - Output only. The list of DS records published for this - domain. The list is automatically populated when - ``ds_state`` is ``DS_RECORDS_PUBLISHED``, otherwise it - remains empty. - """ - - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - ds_state: 'DnsSettings.DsState' = proto.Field( - proto.ENUM, - number=2, - enum='DnsSettings.DsState', - ) - ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='DnsSettings.DsRecord', - ) - - class DsRecord(proto.Message): - r"""Defines a Delegation Signer (DS) record, which is needed to - enable DNSSEC for a domain. It contains a digest (hash) of a - DNSKEY record that must be present in the domain's DNS zone. - - Attributes: - key_tag (int): - The key tag of the record. Must be set in - range 0 -- 65535. - algorithm (google.cloud.domains_v1.types.DnsSettings.DsRecord.Algorithm): - The algorithm used to generate the referenced - DNSKEY. - digest_type (google.cloud.domains_v1.types.DnsSettings.DsRecord.DigestType): - The hash function used to generate the digest - of the referenced DNSKEY. - digest (str): - The digest generated from the referenced - DNSKEY. - """ - class Algorithm(proto.Enum): - r"""List of algorithms used to create a DNSKEY. Certain - algorithms are not supported for particular domains. - - Values: - ALGORITHM_UNSPECIFIED (0): - The algorithm is unspecified. - RSAMD5 (1): - RSA/MD5. Cannot be used for new deployments. - DH (2): - Diffie-Hellman. Cannot be used for new - deployments. - DSA (3): - DSA/SHA1. Not recommended for new - deployments. - ECC (4): - ECC. Not recommended for new deployments. - RSASHA1 (5): - RSA/SHA-1. Not recommended for new - deployments. - DSANSEC3SHA1 (6): - DSA-NSEC3-SHA1. Not recommended for new - deployments. - RSASHA1NSEC3SHA1 (7): - RSA/SHA1-NSEC3-SHA1. Not recommended for new - deployments. - RSASHA256 (8): - RSA/SHA-256. - RSASHA512 (10): - RSA/SHA-512. - ECCGOST (12): - GOST R 34.10-2001. - ECDSAP256SHA256 (13): - ECDSA Curve P-256 with SHA-256. - ECDSAP384SHA384 (14): - ECDSA Curve P-384 with SHA-384. - ED25519 (15): - Ed25519. - ED448 (16): - Ed448. - INDIRECT (252): - Reserved for Indirect Keys. Cannot be used - for new deployments. - PRIVATEDNS (253): - Private algorithm. Cannot be used for new - deployments. - PRIVATEOID (254): - Private algorithm OID. Cannot be used for new - deployments. - """ - ALGORITHM_UNSPECIFIED = 0 - RSAMD5 = 1 - DH = 2 - DSA = 3 - ECC = 4 - RSASHA1 = 5 - DSANSEC3SHA1 = 6 - RSASHA1NSEC3SHA1 = 7 - RSASHA256 = 8 - RSASHA512 = 10 - ECCGOST = 12 - ECDSAP256SHA256 = 13 - ECDSAP384SHA384 = 14 - ED25519 = 15 - ED448 = 16 - INDIRECT = 252 - PRIVATEDNS = 253 - PRIVATEOID = 254 - - class DigestType(proto.Enum): - r"""List of hash functions that may have been used to generate a - digest of a DNSKEY. - - Values: - DIGEST_TYPE_UNSPECIFIED (0): - The DigestType is unspecified. - SHA1 (1): - SHA-1. Not recommended for new deployments. - SHA256 (2): - SHA-256. - GOST3411 (3): - GOST R 34.11-94. - SHA384 (4): - SHA-384. - """ - DIGEST_TYPE_UNSPECIFIED = 0 - SHA1 = 1 - SHA256 = 2 - GOST3411 = 3 - SHA384 = 4 - - key_tag: int = proto.Field( - proto.INT32, - number=1, - ) - algorithm: 'DnsSettings.DsRecord.Algorithm' = proto.Field( - proto.ENUM, - number=2, - enum='DnsSettings.DsRecord.Algorithm', - ) - digest_type: 'DnsSettings.DsRecord.DigestType' = proto.Field( - proto.ENUM, - number=3, - enum='DnsSettings.DsRecord.DigestType', - ) - digest: str = proto.Field( - proto.STRING, - number=4, - ) - - class GlueRecord(proto.Message): - r"""Defines a host on your domain that is a DNS name server for your - domain and/or other domains. Glue records are a way of making the IP - address of a name server known, even when it serves DNS queries for - its parent domain. For example, when ``ns.example.com`` is a name - server for ``example.com``, the host ``ns.example.com`` must have a - glue record to break the circular DNS reference. - - Attributes: - host_name (str): - Required. Domain name of the host in Punycode - format. - ipv4_addresses (MutableSequence[str]): - List of IPv4 addresses corresponding to this host in the - standard decimal format (e.g. ``198.51.100.1``). At least - one of ``ipv4_address`` and ``ipv6_address`` must be set. - ipv6_addresses (MutableSequence[str]): - List of IPv6 addresses corresponding to this host in the - standard hexadecimal format (e.g. ``2001:db8::``). At least - one of ``ipv4_address`` and ``ipv6_address`` must be set. - """ - - host_name: str = proto.Field( - proto.STRING, - number=1, - ) - ipv4_addresses: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=2, - ) - ipv6_addresses: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - - custom_dns: CustomDns = proto.Field( - proto.MESSAGE, - number=1, - oneof='dns_provider', - message=CustomDns, - ) - google_domains_dns: GoogleDomainsDns = proto.Field( - proto.MESSAGE, - number=2, - oneof='dns_provider', - message=GoogleDomainsDns, - ) - glue_records: MutableSequence[GlueRecord] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message=GlueRecord, - ) - - -class ContactSettings(proto.Message): - r"""Defines the contact information associated with a ``Registration``. - - `ICANN `__ requires all domain names to have - associated contact information. The ``registrant_contact`` is - considered the domain's legal owner, and often the other contacts - are identical. - - Attributes: - privacy (google.cloud.domains_v1.types.ContactPrivacy): - Required. Privacy setting for the contacts associated with - the ``Registration``. - registrant_contact (google.cloud.domains_v1.types.ContactSettings.Contact): - Required. The registrant contact for the ``Registration``. - - *Caution: Anyone with access to this email address, phone - number, and/or postal address can take control of the - domain.* - - *Warning: For new ``Registration``\ s, the registrant - receives an email confirmation that they must complete - within 15 days to avoid domain suspension.* - admin_contact (google.cloud.domains_v1.types.ContactSettings.Contact): - Required. The administrative contact for the - ``Registration``. - technical_contact (google.cloud.domains_v1.types.ContactSettings.Contact): - Required. The technical contact for the ``Registration``. - """ - - class Contact(proto.Message): - r"""Details required for a contact associated with a ``Registration``. - - Attributes: - postal_address (google.type.postal_address_pb2.PostalAddress): - Required. Postal address of the contact. - email (str): - Required. Email address of the contact. - phone_number (str): - Required. Phone number of the contact in international - format. For example, ``"+1-800-555-0123"``. - fax_number (str): - Fax number of the contact in international format. For - example, ``"+1-800-555-0123"``. - """ - - postal_address: postal_address_pb2.PostalAddress = proto.Field( - proto.MESSAGE, - number=1, - message=postal_address_pb2.PostalAddress, - ) - email: str = proto.Field( - proto.STRING, - number=2, - ) - phone_number: str = proto.Field( - proto.STRING, - number=3, - ) - fax_number: str = proto.Field( - proto.STRING, - number=4, - ) - - privacy: 'ContactPrivacy' = proto.Field( - proto.ENUM, - number=1, - enum='ContactPrivacy', - ) - registrant_contact: Contact = proto.Field( - proto.MESSAGE, - number=2, - message=Contact, - ) - admin_contact: Contact = proto.Field( - proto.MESSAGE, - number=3, - message=Contact, - ) - technical_contact: Contact = proto.Field( - proto.MESSAGE, - number=4, - message=Contact, - ) - - -class SearchDomainsRequest(proto.Message): - r"""Request for the ``SearchDomains`` method. - - Attributes: - query (str): - Required. String used to search for available - domain names. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - query: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SearchDomainsResponse(proto.Message): - r"""Response for the ``SearchDomains`` method. - - Attributes: - register_parameters (MutableSequence[google.cloud.domains_v1.types.RegisterParameters]): - Results of the domain name search. - """ - - register_parameters: MutableSequence['RegisterParameters'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='RegisterParameters', - ) - - -class RetrieveRegisterParametersRequest(proto.Message): - r"""Request for the ``RetrieveRegisterParameters`` method. - - Attributes: - domain_name (str): - Required. The domain name. Unicode domain - names must be expressed in Punycode format. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RetrieveRegisterParametersResponse(proto.Message): - r"""Response for the ``RetrieveRegisterParameters`` method. - - Attributes: - register_parameters (google.cloud.domains_v1.types.RegisterParameters): - Parameters to use when calling the ``RegisterDomain`` - method. - """ - - register_parameters: 'RegisterParameters' = proto.Field( - proto.MESSAGE, - number=1, - message='RegisterParameters', - ) - - -class RegisterDomainRequest(proto.Message): - r"""Request for the ``RegisterDomain`` method. - - Attributes: - parent (str): - Required. The parent resource of the ``Registration``. Must - be in the format ``projects/*/locations/*``. - registration (google.cloud.domains_v1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - domain_notices (MutableSequence[google.cloud.domains_v1.types.DomainNotice]): - The list of domain notices that you acknowledge. Call - ``RetrieveRegisterParameters`` to see the notices that need - acknowledgement. - contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): - The list of contact notices that the caller acknowledges. - The notices needed here depend on the values specified in - ``registration.contact_settings``. - yearly_price (google.type.money_pb2.Money): - Required. Yearly price to register or renew - the domain. The value that should be put here - can be obtained from RetrieveRegisterParameters - or SearchDomains calls. - validate_only (bool): - When true, only validation is performed, without actually - registering the domain. Follows: - https://cloud.google.com/apis/design/design_patterns#request_validation - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=2, - message='Registration', - ) - domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='DomainNotice', - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='ContactNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=5, - message=money_pb2.Money, - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=6, - ) - - -class RetrieveTransferParametersRequest(proto.Message): - r"""Request for the ``RetrieveTransferParameters`` method. - - Attributes: - domain_name (str): - Required. The domain name. Unicode domain - names must be expressed in Punycode format. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RetrieveTransferParametersResponse(proto.Message): - r"""Response for the ``RetrieveTransferParameters`` method. - - Attributes: - transfer_parameters (google.cloud.domains_v1.types.TransferParameters): - Parameters to use when calling the ``TransferDomain`` - method. - """ - - transfer_parameters: 'TransferParameters' = proto.Field( - proto.MESSAGE, - number=1, - message='TransferParameters', - ) - - -class TransferDomainRequest(proto.Message): - r"""Request for the ``TransferDomain`` method. - - Attributes: - parent (str): - Required. The parent resource of the ``Registration``. Must - be in the format ``projects/*/locations/*``. - registration (google.cloud.domains_v1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to import - the domain's current DNS configuration from its current - registrar. Use this option only if you are sure that the - domain's current DNS service does not cease upon transfer, - as is often the case for DNS services provided for free by - the registrar. - contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): - The list of contact notices that you acknowledge. The - notices needed here depend on the values specified in - ``registration.contact_settings``. - yearly_price (google.type.money_pb2.Money): - Required. Acknowledgement of the price to transfer or renew - the domain for one year. Call ``RetrieveTransferParameters`` - to obtain the price, which you must acknowledge. - authorization_code (google.cloud.domains_v1.types.AuthorizationCode): - The domain's transfer authorization code. You - can obtain this from the domain's current - registrar. - validate_only (bool): - Validate the request without actually - transferring the domain. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=2, - message='Registration', - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='ContactNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=4, - message=money_pb2.Money, - ) - authorization_code: 'AuthorizationCode' = proto.Field( - proto.MESSAGE, - number=5, - message='AuthorizationCode', - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=6, - ) - - -class ListRegistrationsRequest(proto.Message): - r"""Request for the ``ListRegistrations`` method. - - Attributes: - parent (str): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - page_size (int): - Maximum number of results to return. - page_token (str): - When set to the ``next_page_token`` from a prior response, - provides the next page of results. - filter (str): - Filter expression to restrict the ``Registration``\ s - returned. - - The expression must specify the field name, a comparison - operator, and the value that you want to use for filtering. - The value must be a string, a number, a boolean, or an enum - value. The comparison operator should be one of =, !=, >, <, - >=, <=, or : for prefix or wildcard matches. - - For example, to filter to a specific domain name, use an - expression like ``domainName="example.com"``. You can also - check for the existence of a field; for example, to find - domains using custom DNS settings, use an expression like - ``dnsSettings.customDns:*``. - - You can also create compound filters by combining - expressions with the ``AND`` and ``OR`` operators. For - example, to find domains that are suspended or have specific - issues flagged, use an expression like - ``(state=SUSPENDED) OR (issue:*)``. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - filter: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListRegistrationsResponse(proto.Message): - r"""Response for the ``ListRegistrations`` method. - - Attributes: - registrations (MutableSequence[google.cloud.domains_v1.types.Registration]): - A list of ``Registration``\ s. - next_page_token (str): - When present, there are more results to retrieve. Set - ``page_token`` to this value on a subsequent call to get the - next page of results. - """ - - @property - def raw_page(self): - return self - - registrations: MutableSequence['Registration'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Registration', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetRegistrationRequest(proto.Message): - r"""Request for the ``GetRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to get, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateRegistrationRequest(proto.Message): - r"""Request for the ``UpdateRegistration`` method. - - Attributes: - registration (google.cloud.domains_v1.types.Registration): - Fields of the ``Registration`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the labels - are being updated, the ``update_mask`` is ``"labels"``. - """ - - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=1, - message='Registration', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class ConfigureManagementSettingsRequest(proto.Message): - r"""Request for the ``ConfigureManagementSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose management - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - management_settings (google.cloud.domains_v1.types.ManagementSettings): - Fields of the ``ManagementSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the transfer - lock is being updated, the ``update_mask`` is - ``"transfer_lock_state"``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - management_settings: 'ManagementSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='ManagementSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - - -class ConfigureDnsSettingsRequest(proto.Message): - r"""Request for the ``ConfigureDnsSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - dns_settings (google.cloud.domains_v1.types.DnsSettings): - Fields of the ``DnsSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the name - servers are being updated for an existing Custom DNS - configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains DNS - configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - validate_only (bool): - Validate the request without actually - updating the DNS settings. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - dns_settings: 'DnsSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='DnsSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=4, - ) - - -class ConfigureContactSettingsRequest(proto.Message): - r"""Request for the ``ConfigureContactSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - contact_settings (google.cloud.domains_v1.types.ContactSettings): - Fields of the ``ContactSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the - registrant contact is being updated, the ``update_mask`` is - ``"registrant_contact"``. - contact_notices (MutableSequence[google.cloud.domains_v1.types.ContactNotice]): - The list of contact notices that the caller acknowledges. - The notices needed here depend on the values specified in - ``contact_settings``. - validate_only (bool): - Validate the request without actually - updating the contact settings. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='ContactSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='ContactNotice', - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=5, - ) - - -class ExportRegistrationRequest(proto.Message): - r"""Request for the ``ExportRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to export, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteRegistrationRequest(proto.Message): - r"""Request for the ``DeleteRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to delete, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class RetrieveAuthorizationCodeRequest(proto.Message): - r"""Request for the ``RetrieveAuthorizationCode`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ResetAuthorizationCodeRequest(proto.Message): - r"""Request for the ``ResetAuthorizationCode`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - - -class RegisterParameters(proto.Message): - r"""Parameters required to register a new domain. - - Attributes: - domain_name (str): - The domain name. Unicode domain names are - expressed in Punycode format. - availability (google.cloud.domains_v1.types.RegisterParameters.Availability): - Indicates whether the domain is available for registration. - This value is accurate when obtained by calling - ``RetrieveRegisterParameters``, but is approximate when - obtained by calling ``SearchDomains``. - supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): - Contact privacy options that the domain - supports. - domain_notices (MutableSequence[google.cloud.domains_v1.types.DomainNotice]): - Notices about special properties of the - domain. - yearly_price (google.type.money_pb2.Money): - Price to register or renew the domain for one - year. - """ - class Availability(proto.Enum): - r"""Possible availability states of a domain name. - - Values: - AVAILABILITY_UNSPECIFIED (0): - The availability is unspecified. - AVAILABLE (1): - The domain is available for registration. - UNAVAILABLE (2): - The domain is not available for registration. - Generally this means it is already registered to - another party. - UNSUPPORTED (3): - The domain is not currently supported by - Cloud Domains, but may be available elsewhere. - UNKNOWN (4): - Cloud Domains is unable to determine domain - availability, generally due to system - maintenance at the domain name registry. - """ - AVAILABILITY_UNSPECIFIED = 0 - AVAILABLE = 1 - UNAVAILABLE = 2 - UNSUPPORTED = 3 - UNKNOWN = 4 - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - availability: Availability = proto.Field( - proto.ENUM, - number=2, - enum=Availability, - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='ContactPrivacy', - ) - domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='DomainNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=5, - message=money_pb2.Money, - ) - - -class TransferParameters(proto.Message): - r"""Parameters required to transfer a domain from another - registrar. - - Attributes: - domain_name (str): - The domain name. Unicode domain names are - expressed in Punycode format. - current_registrar (str): - The registrar that currently manages the - domain. - name_servers (MutableSequence[str]): - The name servers that currently store the - configuration of the domain. - transfer_lock_state (google.cloud.domains_v1.types.TransferLockState): - Indicates whether the domain is protected by a transfer - lock. For a transfer to succeed, this must show - ``UNLOCKED``. To unlock a domain, go to its current - registrar. - supported_privacy (MutableSequence[google.cloud.domains_v1.types.ContactPrivacy]): - Contact privacy options that the domain - supports. - yearly_price (google.type.money_pb2.Money): - Price to transfer or renew the domain for one - year. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - current_registrar: str = proto.Field( - proto.STRING, - number=2, - ) - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - transfer_lock_state: 'TransferLockState' = proto.Field( - proto.ENUM, - number=4, - enum='TransferLockState', - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=5, - enum='ContactPrivacy', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=6, - message=money_pb2.Money, - ) - - -class AuthorizationCode(proto.Message): - r"""Defines an authorization code. - - Attributes: - code (str): - The Authorization Code in ASCII. It can be - used to transfer the domain to or from another - registrar. - """ - - code: str = proto.Field( - proto.STRING, - number=1, - ) - - -class OperationMetadata(proto.Message): - r"""Represents the metadata of the long-running operation. Output - only. - - Attributes: - create_time (google.protobuf.timestamp_pb2.Timestamp): - The time the operation was created. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time the operation finished running. - target (str): - Server-defined resource path for the target - of the operation. - verb (str): - Name of the verb executed by the operation. - status_detail (str): - Human-readable status of the operation, if - any. - api_version (str): - API version used to start the operation. - """ - - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - target: str = proto.Field( - proto.STRING, - number=3, - ) - verb: str = proto.Field( - proto.STRING, - number=4, - ) - status_detail: str = proto.Field( - proto.STRING, - number=5, - ) - api_version: str = proto.Field( - proto.STRING, - number=6, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 574c5ae..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 0358546..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/domains_v1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==4.0.1", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py deleted file mode 100644 index 585c2f3..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureContactSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureContactSettings_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 domains_v1 - - -async def sample_configure_contact_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureContactSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py deleted file mode 100644 index 194933c..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_contact_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureContactSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureContactSettings_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 domains_v1 - - -def sample_configure_contact_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureContactSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py deleted file mode 100644 index 98ccae9..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureDnsSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureDnsSettings_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 domains_v1 - - -async def sample_configure_dns_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureDnsSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py deleted file mode 100644 index 111b4e6..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_dns_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureDnsSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureDnsSettings_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 domains_v1 - - -def sample_configure_dns_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureDnsSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py deleted file mode 100644 index ce082da..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureManagementSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureManagementSettings_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 domains_v1 - - -async def sample_configure_management_settings(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureManagementSettings_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py deleted file mode 100644 index 834a0fc..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_configure_management_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureManagementSettings -# 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-domains - - -# [START domains_v1_generated_Domains_ConfigureManagementSettings_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 domains_v1 - - -def sample_configure_management_settings(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ConfigureManagementSettings_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py deleted file mode 100644 index 2cf9e84..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_DeleteRegistration_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 domains_v1 - - -async def sample_delete_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_DeleteRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py deleted file mode 100644 index 468a20a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_delete_registration_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_DeleteRegistration_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 domains_v1 - - -def sample_delete_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_DeleteRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py deleted file mode 100644 index 8cb7dc7..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ExportRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_ExportRegistration_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 domains_v1 - - -async def sample_export_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ExportRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py deleted file mode 100644 index 28868cb..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_export_registration_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ExportRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_ExportRegistration_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 domains_v1 - - -def sample_export_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ExportRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py deleted file mode 100644 index d339699..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_GetRegistration_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 domains_v1 - - -async def sample_get_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_registration(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_GetRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py deleted file mode 100644 index 1f05063..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_get_registration_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_GetRegistration_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 domains_v1 - - -def sample_get_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = client.get_registration(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_GetRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py deleted file mode 100644 index 935036d..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListRegistrations -# 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-domains - - -# [START domains_v1_generated_Domains_ListRegistrations_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 domains_v1 - - -async def sample_list_registrations(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END domains_v1_generated_Domains_ListRegistrations_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py deleted file mode 100644 index 30d1f85..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_list_registrations_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListRegistrations -# 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-domains - - -# [START domains_v1_generated_Domains_ListRegistrations_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 domains_v1 - - -def sample_list_registrations(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END domains_v1_generated_Domains_ListRegistrations_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py deleted file mode 100644 index 62d1fa4..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_async.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDomain -# 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-domains - - -# [START domains_v1_generated_Domains_RegisterDomain_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 domains_v1 - - -async def sample_register_domain(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RegisterDomain_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py deleted file mode 100644 index e9ddd16..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_register_domain_sync.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDomain -# 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-domains - - -# [START domains_v1_generated_Domains_RegisterDomain_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 domains_v1 - - -def sample_register_domain(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RegisterDomain_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py deleted file mode 100644 index c1c87d7..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ResetAuthorizationCode -# 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-domains - - -# [START domains_v1_generated_Domains_ResetAuthorizationCode_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 domains_v1 - - -async def sample_reset_authorization_code(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.reset_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ResetAuthorizationCode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py deleted file mode 100644 index 985ce1b..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_reset_authorization_code_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ResetAuthorizationCode -# 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-domains - - -# [START domains_v1_generated_Domains_ResetAuthorizationCode_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 domains_v1 - - -def sample_reset_authorization_code(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.reset_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_ResetAuthorizationCode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py deleted file mode 100644 index 5e62fdf..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveAuthorizationCode -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1 - - -async def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveAuthorizationCode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py deleted file mode 100644 index b8976f4..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_authorization_code_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveAuthorizationCode -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1 - - -def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveAuthorizationCode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py deleted file mode 100644 index 416d8d0..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveRegisterParameters -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveRegisterParameters_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 domains_v1 - - -async def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveRegisterParameters_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py deleted file mode 100644 index 1195433..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_register_parameters_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveRegisterParameters -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveRegisterParameters_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 domains_v1 - - -def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveRegisterParameters_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py deleted file mode 100644 index 7fbb86d..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveTransferParameters -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveTransferParameters_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 domains_v1 - - -async def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveTransferParameters_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py deleted file mode 100644 index 5ed9f4c..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_retrieve_transfer_parameters_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveTransferParameters -# 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-domains - - -# [START domains_v1_generated_Domains_RetrieveTransferParameters_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 domains_v1 - - -def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_RetrieveTransferParameters_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py deleted file mode 100644 index 276f24a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SearchDomains -# 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-domains - - -# [START domains_v1_generated_Domains_SearchDomains_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 domains_v1 - - -async def sample_search_domains(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = await client.search_domains(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_SearchDomains_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py deleted file mode 100644 index 1ccb1f0..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_search_domains_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SearchDomains -# 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-domains - - -# [START domains_v1_generated_Domains_SearchDomains_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 domains_v1 - - -def sample_search_domains(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = client.search_domains(request=request) - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_SearchDomains_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py deleted file mode 100644 index cb5b269..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_async.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for TransferDomain -# 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-domains - - -# [START domains_v1_generated_Domains_TransferDomain_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 domains_v1 - - -async def sample_transfer_domain(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_TransferDomain_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py deleted file mode 100644 index 213561a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_transfer_domain_sync.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for TransferDomain -# 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-domains - - -# [START domains_v1_generated_Domains_TransferDomain_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 domains_v1 - - -def sample_transfer_domain(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_TransferDomain_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py deleted file mode 100644 index 47c24db..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_async.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_UpdateRegistration_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 domains_v1 - - -async def sample_update_registration(): - # Create a client - client = domains_v1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_UpdateRegistration_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py b/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py deleted file mode 100644 index 4718109..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/domains_v1_generated_domains_update_registration_sync.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateRegistration -# 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-domains - - -# [START domains_v1_generated_Domains_UpdateRegistration_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 domains_v1 - - -def sample_update_registration(): - # Create a client - client = domains_v1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1_generated_Domains_UpdateRegistration_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json deleted file mode 100644 index 5384077..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1.json +++ /dev/null @@ -1,2550 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.domains.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-cloud-domains", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_contact_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureContactSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureContactSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureContactSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "contact_settings", - "type": "google.cloud.domains_v1.types.ContactSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_contact_settings" - }, - "description": "Sample for ConfigureContactSettings", - "file": "domains_v1_generated_domains_configure_contact_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureContactSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_contact_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.configure_contact_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureContactSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureContactSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureContactSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "contact_settings", - "type": "google.cloud.domains_v1.types.ContactSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_contact_settings" - }, - "description": "Sample for ConfigureContactSettings", - "file": "domains_v1_generated_domains_configure_contact_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureContactSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_contact_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_dns_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureDnsSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureDnsSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureDnsSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "dns_settings", - "type": "google.cloud.domains_v1.types.DnsSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_dns_settings" - }, - "description": "Sample for ConfigureDnsSettings", - "file": "domains_v1_generated_domains_configure_dns_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureDnsSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_dns_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.configure_dns_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureDnsSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureDnsSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureDnsSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "dns_settings", - "type": "google.cloud.domains_v1.types.DnsSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_dns_settings" - }, - "description": "Sample for ConfigureDnsSettings", - "file": "domains_v1_generated_domains_configure_dns_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureDnsSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_dns_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.configure_management_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureManagementSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureManagementSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureManagementSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "management_settings", - "type": "google.cloud.domains_v1.types.ManagementSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_management_settings" - }, - "description": "Sample for ConfigureManagementSettings", - "file": "domains_v1_generated_domains_configure_management_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureManagementSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_management_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.configure_management_settings", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ConfigureManagementSettings", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureManagementSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ConfigureManagementSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "management_settings", - "type": "google.cloud.domains_v1.types.ManagementSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_management_settings" - }, - "description": "Sample for ConfigureManagementSettings", - "file": "domains_v1_generated_domains_configure_management_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ConfigureManagementSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_configure_management_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.delete_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.DeleteRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "DeleteRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.DeleteRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "delete_registration" - }, - "description": "Sample for DeleteRegistration", - "file": "domains_v1_generated_domains_delete_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_DeleteRegistration_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_delete_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.delete_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.DeleteRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "DeleteRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.DeleteRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "delete_registration" - }, - "description": "Sample for DeleteRegistration", - "file": "domains_v1_generated_domains_delete_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_DeleteRegistration_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_delete_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.export_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ExportRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ExportRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ExportRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "export_registration" - }, - "description": "Sample for ExportRegistration", - "file": "domains_v1_generated_domains_export_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ExportRegistration_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_export_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.export_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ExportRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ExportRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ExportRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "export_registration" - }, - "description": "Sample for ExportRegistration", - "file": "domains_v1_generated_domains_export_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ExportRegistration_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_export_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.get_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.GetRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "GetRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.GetRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.Registration", - "shortName": "get_registration" - }, - "description": "Sample for GetRegistration", - "file": "domains_v1_generated_domains_get_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_GetRegistration_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": "domains_v1_generated_domains_get_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.get_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.GetRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "GetRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.GetRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.Registration", - "shortName": "get_registration" - }, - "description": "Sample for GetRegistration", - "file": "domains_v1_generated_domains_get_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_GetRegistration_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": "domains_v1_generated_domains_get_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.list_registrations", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ListRegistrations", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ListRegistrations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ListRegistrationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.services.domains.pagers.ListRegistrationsAsyncPager", - "shortName": "list_registrations" - }, - "description": "Sample for ListRegistrations", - "file": "domains_v1_generated_domains_list_registrations_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ListRegistrations_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": "domains_v1_generated_domains_list_registrations_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.list_registrations", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ListRegistrations", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ListRegistrations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ListRegistrationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.services.domains.pagers.ListRegistrationsPager", - "shortName": "list_registrations" - }, - "description": "Sample for ListRegistrations", - "file": "domains_v1_generated_domains_list_registrations_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ListRegistrations_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": "domains_v1_generated_domains_list_registrations_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.register_domain", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RegisterDomain", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RegisterDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RegisterDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "register_domain" - }, - "description": "Sample for RegisterDomain", - "file": "domains_v1_generated_domains_register_domain_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RegisterDomain_async", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_register_domain_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.register_domain", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RegisterDomain", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RegisterDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RegisterDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "register_domain" - }, - "description": "Sample for RegisterDomain", - "file": "domains_v1_generated_domains_register_domain_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RegisterDomain_sync", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_register_domain_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.reset_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ResetAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ResetAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ResetAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.AuthorizationCode", - "shortName": "reset_authorization_code" - }, - "description": "Sample for ResetAuthorizationCode", - "file": "domains_v1_generated_domains_reset_authorization_code_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ResetAuthorizationCode_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": "domains_v1_generated_domains_reset_authorization_code_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.reset_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1.Domains.ResetAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "ResetAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.ResetAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.AuthorizationCode", - "shortName": "reset_authorization_code" - }, - "description": "Sample for ResetAuthorizationCode", - "file": "domains_v1_generated_domains_reset_authorization_code_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_ResetAuthorizationCode_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": "domains_v1_generated_domains_reset_authorization_code_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.AuthorizationCode", - "shortName": "retrieve_authorization_code" - }, - "description": "Sample for RetrieveAuthorizationCode", - "file": "domains_v1_generated_domains_retrieve_authorization_code_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1_generated_domains_retrieve_authorization_code_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.AuthorizationCode", - "shortName": "retrieve_authorization_code" - }, - "description": "Sample for RetrieveAuthorizationCode", - "file": "domains_v1_generated_domains_retrieve_authorization_code_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1_generated_domains_retrieve_authorization_code_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_register_parameters", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveRegisterParameters", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveRegisterParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveRegisterParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.RetrieveRegisterParametersResponse", - "shortName": "retrieve_register_parameters" - }, - "description": "Sample for RetrieveRegisterParameters", - "file": "domains_v1_generated_domains_retrieve_register_parameters_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1_generated_domains_retrieve_register_parameters_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_register_parameters", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveRegisterParameters", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveRegisterParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveRegisterParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.RetrieveRegisterParametersResponse", - "shortName": "retrieve_register_parameters" - }, - "description": "Sample for RetrieveRegisterParameters", - "file": "domains_v1_generated_domains_retrieve_register_parameters_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1_generated_domains_retrieve_register_parameters_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.retrieve_transfer_parameters", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveTransferParameters", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveTransferParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveTransferParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.RetrieveTransferParametersResponse", - "shortName": "retrieve_transfer_parameters" - }, - "description": "Sample for RetrieveTransferParameters", - "file": "domains_v1_generated_domains_retrieve_transfer_parameters_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveTransferParameters_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": "domains_v1_generated_domains_retrieve_transfer_parameters_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.retrieve_transfer_parameters", - "method": { - "fullName": "google.cloud.domains.v1.Domains.RetrieveTransferParameters", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveTransferParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.RetrieveTransferParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.RetrieveTransferParametersResponse", - "shortName": "retrieve_transfer_parameters" - }, - "description": "Sample for RetrieveTransferParameters", - "file": "domains_v1_generated_domains_retrieve_transfer_parameters_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_RetrieveTransferParameters_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": "domains_v1_generated_domains_retrieve_transfer_parameters_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.search_domains", - "method": { - "fullName": "google.cloud.domains.v1.Domains.SearchDomains", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "SearchDomains" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.SearchDomainsRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.SearchDomainsResponse", - "shortName": "search_domains" - }, - "description": "Sample for SearchDomains", - "file": "domains_v1_generated_domains_search_domains_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_SearchDomains_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": "domains_v1_generated_domains_search_domains_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.search_domains", - "method": { - "fullName": "google.cloud.domains.v1.Domains.SearchDomains", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "SearchDomains" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.SearchDomainsRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1.types.SearchDomainsResponse", - "shortName": "search_domains" - }, - "description": "Sample for SearchDomains", - "file": "domains_v1_generated_domains_search_domains_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_SearchDomains_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": "domains_v1_generated_domains_search_domains_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.transfer_domain", - "method": { - "fullName": "google.cloud.domains.v1.Domains.TransferDomain", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "TransferDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.TransferDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "authorization_code", - "type": "google.cloud.domains_v1.types.AuthorizationCode" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "transfer_domain" - }, - "description": "Sample for TransferDomain", - "file": "domains_v1_generated_domains_transfer_domain_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_TransferDomain_async", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_transfer_domain_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.transfer_domain", - "method": { - "fullName": "google.cloud.domains.v1.Domains.TransferDomain", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "TransferDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.TransferDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "authorization_code", - "type": "google.cloud.domains_v1.types.AuthorizationCode" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "transfer_domain" - }, - "description": "Sample for TransferDomain", - "file": "domains_v1_generated_domains_transfer_domain_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_TransferDomain_sync", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_transfer_domain_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1.DomainsAsyncClient.update_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.UpdateRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "UpdateRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.UpdateRegistrationRequest" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "update_registration" - }, - "description": "Sample for UpdateRegistration", - "file": "domains_v1_generated_domains_update_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_UpdateRegistration_async", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_update_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1.DomainsClient.update_registration", - "method": { - "fullName": "google.cloud.domains.v1.Domains.UpdateRegistration", - "service": { - "fullName": "google.cloud.domains.v1.Domains", - "shortName": "Domains" - }, - "shortName": "UpdateRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1.types.UpdateRegistrationRequest" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1.types.Registration" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "update_registration" - }, - "description": "Sample for UpdateRegistration", - "file": "domains_v1_generated_domains_update_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1_generated_Domains_UpdateRegistration_sync", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1_generated_domains_update_registration_sync.py" - } - ] -} diff --git a/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py deleted file mode 100644 index 39c812d..0000000 --- a/owl-bot-staging/v1/scripts/fixup_domains_v1_keywords.py +++ /dev/null @@ -1,190 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class domainsCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'configure_contact_settings': ('registration', 'update_mask', 'contact_settings', 'contact_notices', 'validate_only', ), - 'configure_dns_settings': ('registration', 'update_mask', 'dns_settings', 'validate_only', ), - 'configure_management_settings': ('registration', 'update_mask', 'management_settings', ), - 'delete_registration': ('name', ), - 'export_registration': ('name', ), - 'get_registration': ('name', ), - 'list_registrations': ('parent', 'page_size', 'page_token', 'filter', ), - 'register_domain': ('parent', 'registration', 'yearly_price', 'domain_notices', 'contact_notices', 'validate_only', ), - 'reset_authorization_code': ('registration', ), - 'retrieve_authorization_code': ('registration', ), - 'retrieve_register_parameters': ('domain_name', 'location', ), - 'retrieve_transfer_parameters': ('domain_name', 'location', ), - 'search_domains': ('query', 'location', ), - 'transfer_domain': ('parent', 'registration', 'yearly_price', 'contact_notices', 'authorization_code', 'validate_only', ), - 'update_registration': ('update_mask', 'registration', ), - } - - 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=domainsCallTransformer(), -): - """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 domains client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index 70be905..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-domains' - - -description = "Google Cloud Domains API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/domains/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-domains" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +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.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py b/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py deleted file mode 100644 index 8f61ecc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/domains_v1/test_domains.py +++ /dev/null @@ -1,8728 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import future -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import operation -from google.api_core import operation_async # type: ignore -from google.api_core import operations_v1 -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.domains_v1.services.domains import DomainsAsyncClient -from google.cloud.domains_v1.services.domains import DomainsClient -from google.cloud.domains_v1.services.domains import pagers -from google.cloud.domains_v1.services.domains import transports -from google.cloud.domains_v1.types import domains -from google.longrunning import operations_pb2 -from google.oauth2 import service_account -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from google.type import postal_address_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert DomainsClient._get_default_mtls_endpoint(None) is None - assert DomainsClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (DomainsClient, "grpc"), - (DomainsAsyncClient, "grpc_asyncio"), - (DomainsClient, "rest"), -]) -def test_domains_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 == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://domains.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.DomainsGrpcTransport, "grpc"), - (transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.DomainsRestTransport, "rest"), -]) -def test_domains_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", [ - (DomainsClient, "grpc"), - (DomainsAsyncClient, "grpc_asyncio"), - (DomainsClient, "rest"), -]) -def test_domains_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 == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://domains.googleapis.com' - ) - - -def test_domains_client_get_transport_class(): - transport = DomainsClient.get_transport_class() - available_transports = [ - transports.DomainsGrpcTransport, - transports.DomainsRestTransport, - ] - assert transport in available_transports - - transport = DomainsClient.get_transport_class("grpc") - assert transport == transports.DomainsGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (DomainsClient, transports.DomainsRestTransport, "rest"), -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -def test_domains_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(DomainsClient, '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(DomainsClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class(transport=transport_name) - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class(transport=transport_name) - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", "true"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (DomainsClient, transports.DomainsGrpcTransport, "grpc", "false"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (DomainsClient, transports.DomainsRestTransport, "rest", "true"), - (DomainsClient, transports.DomainsRestTransport, "rest", "false"), -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_domains_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class", [ - DomainsClient, DomainsAsyncClient -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -def test_domains_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (DomainsClient, transports.DomainsRestTransport, "rest"), -]) -def test_domains_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (DomainsClient, transports.DomainsRestTransport, "rest", None), -]) -def test_domains_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -def test_domains_client_client_options_from_dict(): - with mock.patch('google.cloud.domains_v1.services.domains.transports.DomainsGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = DomainsClient( - 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", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_domains_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "domains.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="domains.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - domains.SearchDomainsRequest, - dict, -]) -def test_search_domains(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse( - ) - response = client.search_domains(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -def test_search_domains_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - client.search_domains() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - -@pytest.mark.asyncio -async def test_search_domains_async(transport: str = 'grpc_asyncio', request_type=domains.SearchDomainsRequest): - client = DomainsAsyncClient( - 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_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse( - )) - response = await client.search_domains(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -@pytest.mark.asyncio -async def test_search_domains_async_from_dict(): - await test_search_domains_async(request_type=dict) - - -def test_search_domains_field_headers(): - client = DomainsClient( - 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 = domains.SearchDomainsRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - call.return_value = domains.SearchDomainsResponse() - client.search_domains(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_search_domains_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.SearchDomainsRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) - await client.search_domains(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_search_domains_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_domains( - location='location_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].query - mock_val = 'query_value' - assert arg == mock_val - - -def test_search_domains_flattened_error(): - client = DomainsClient( - 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_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - -@pytest.mark.asyncio -async def test_search_domains_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_domains( - location='location_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].query - mock_val = 'query_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_search_domains_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveRegisterParametersRequest, - dict, -]) -def test_retrieve_register_parameters(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse( - ) - response = client.retrieve_register_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -def test_retrieve_register_parameters_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - client.retrieve_register_parameters() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveRegisterParametersRequest): - client = DomainsAsyncClient( - 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.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse( - )) - response = await client.retrieve_register_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_async_from_dict(): - await test_retrieve_register_parameters_async(request_type=dict) - - -def test_retrieve_register_parameters_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveRegisterParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - call.return_value = domains.RetrieveRegisterParametersResponse() - client.retrieve_register_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveRegisterParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) - await client.retrieve_register_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_retrieve_register_parameters_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_register_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - - -def test_retrieve_register_parameters_flattened_error(): - client = DomainsClient( - 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.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_register_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RegisterDomainRequest, - dict, -]) -def test_register_domain(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.register_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_register_domain_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - client.register_domain() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - -@pytest.mark.asyncio -async def test_register_domain_async(transport: str = 'grpc_asyncio', request_type=domains.RegisterDomainRequest): - client = DomainsAsyncClient( - 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.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.register_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_register_domain_async_from_dict(): - await test_register_domain_async(request_type=dict) - - -def test_register_domain_field_headers(): - client = DomainsClient( - 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 = domains.RegisterDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.register_domain(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_register_domain_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RegisterDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.register_domain(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_register_domain_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.register_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - - -def test_register_domain_flattened_error(): - client = DomainsClient( - 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.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - -@pytest.mark.asyncio -async def test_register_domain_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.register_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_register_domain_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveTransferParametersRequest, - dict, -]) -def test_retrieve_transfer_parameters(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse( - ) - response = client.retrieve_transfer_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -def test_retrieve_transfer_parameters_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - client.retrieve_transfer_parameters() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveTransferParametersRequest): - client = DomainsAsyncClient( - 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.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse( - )) - response = await client.retrieve_transfer_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_async_from_dict(): - await test_retrieve_transfer_parameters_async(request_type=dict) - - -def test_retrieve_transfer_parameters_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveTransferParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - call.return_value = domains.RetrieveTransferParametersResponse() - client.retrieve_transfer_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveTransferParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) - await client.retrieve_transfer_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_retrieve_transfer_parameters_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_transfer_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - - -def test_retrieve_transfer_parameters_flattened_error(): - client = DomainsClient( - 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.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_transfer_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.TransferDomainRequest, - dict, -]) -def test_transfer_domain(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.transfer_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_transfer_domain_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - client.transfer_domain() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - -@pytest.mark.asyncio -async def test_transfer_domain_async(transport: str = 'grpc_asyncio', request_type=domains.TransferDomainRequest): - client = DomainsAsyncClient( - 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.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.transfer_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_transfer_domain_async_from_dict(): - await test_transfer_domain_async(request_type=dict) - - -def test_transfer_domain_field_headers(): - client = DomainsClient( - 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 = domains.TransferDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.transfer_domain(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_transfer_domain_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.TransferDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.transfer_domain(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_transfer_domain_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.transfer_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - arg = args[0].authorization_code - mock_val = domains.AuthorizationCode(code='code_value') - assert arg == mock_val - - -def test_transfer_domain_flattened_error(): - client = DomainsClient( - 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.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - -@pytest.mark.asyncio -async def test_transfer_domain_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.transfer_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - arg = args[0].authorization_code - mock_val = domains.AuthorizationCode(code='code_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_transfer_domain_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ListRegistrationsRequest, - dict, -]) -def test_list_registrations(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_registrations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_registrations_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - client.list_registrations() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - -@pytest.mark.asyncio -async def test_list_registrations_async(transport: str = 'grpc_asyncio', request_type=domains.ListRegistrationsRequest): - client = DomainsAsyncClient( - 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_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_registrations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_registrations_async_from_dict(): - await test_list_registrations_async(request_type=dict) - - -def test_list_registrations_field_headers(): - client = DomainsClient( - 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 = domains.ListRegistrationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - call.return_value = domains.ListRegistrationsResponse() - client.list_registrations(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_registrations_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ListRegistrationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) - await client.list_registrations(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_registrations_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_registrations( - 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_registrations_flattened_error(): - client = DomainsClient( - 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_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_registrations_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_registrations( - 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_registrations_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - - -def test_list_registrations_pager(transport_name: str = "grpc"): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_registrations(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, domains.Registration) - for i in results) -def test_list_registrations_pages(transport_name: str = "grpc"): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - pages = list(client.list_registrations(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_registrations_async_pager(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_registrations(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, domains.Registration) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_registrations_async_pages(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_registrations(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - domains.GetRegistrationRequest, - dict, -]) -def test_get_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - ) - response = client.get_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -def test_get_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - client.get_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - -@pytest.mark.asyncio -async def test_get_registration_async(transport: str = 'grpc_asyncio', request_type=domains.GetRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - )) - response = await client.get_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -@pytest.mark.asyncio -async def test_get_registration_async_from_dict(): - await test_get_registration_async(request_type=dict) - - -def test_get_registration_field_headers(): - client = DomainsClient( - 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 = domains.GetRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - call.return_value = domains.Registration() - client.get_registration(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_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.GetRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) - await client.get_registration(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_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_registration( - 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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_registration( - 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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.UpdateRegistrationRequest, - dict, -]) -def test_update_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.update_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_update_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - client.update_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - -@pytest.mark.asyncio -async def test_update_registration_async(transport: str = 'grpc_asyncio', request_type=domains.UpdateRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.update_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_update_registration_async_from_dict(): - await test_update_registration_async(request_type=dict) - - -def test_update_registration_field_headers(): - client = DomainsClient( - 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 = domains.UpdateRegistrationRequest() - - request.registration.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.update_registration(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', - 'registration.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.UpdateRegistrationRequest() - - request.registration.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.update_registration(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', - 'registration.name=name_value', - ) in kw['metadata'] - - -def test_update_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_registration( - registration=domains.Registration(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].registration - mock_val = domains.Registration(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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_registration( - registration=domains.Registration(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].registration - mock_val = domains.Registration(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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureManagementSettingsRequest, - dict, -]) -def test_configure_management_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_management_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_management_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - client.configure_management_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_management_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureManagementSettingsRequest): - client = DomainsAsyncClient( - 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.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_management_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_management_settings_async_from_dict(): - await test_configure_management_settings_async(request_type=dict) - - -def test_configure_management_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureManagementSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_management_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_management_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureManagementSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_management_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_management_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_management_settings( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].management_settings - mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_configure_management_settings_flattened_error(): - client = DomainsClient( - 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.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_management_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_management_settings( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].management_settings - mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) - 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_configure_management_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureDnsSettingsRequest, - dict, -]) -def test_configure_dns_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_dns_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_dns_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - client.configure_dns_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_dns_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureDnsSettingsRequest): - client = DomainsAsyncClient( - 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.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_dns_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_dns_settings_async_from_dict(): - await test_configure_dns_settings_async(request_type=dict) - - -def test_configure_dns_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureDnsSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_dns_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_dns_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureDnsSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_dns_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_dns_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_dns_settings( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].dns_settings - mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error(): - client = DomainsClient( - 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.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_dns_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_dns_settings( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].dns_settings - mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureContactSettingsRequest, - dict, -]) -def test_configure_contact_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_contact_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_contact_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - client.configure_contact_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_contact_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureContactSettingsRequest): - client = DomainsAsyncClient( - 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.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_contact_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_contact_settings_async_from_dict(): - await test_configure_contact_settings_async(request_type=dict) - - -def test_configure_contact_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureContactSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_contact_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_contact_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureContactSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_contact_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_contact_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_contact_settings( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].contact_settings - mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_configure_contact_settings_flattened_error(): - client = DomainsClient( - 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.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_contact_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_contact_settings( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].contact_settings - mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) - 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_configure_contact_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ExportRegistrationRequest, - dict, -]) -def test_export_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.export_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_export_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - client.export_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - -@pytest.mark.asyncio -async def test_export_registration_async(transport: str = 'grpc_asyncio', request_type=domains.ExportRegistrationRequest): - client = DomainsAsyncClient( - 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.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.export_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_export_registration_async_from_dict(): - await test_export_registration_async(request_type=dict) - - -def test_export_registration_field_headers(): - client = DomainsClient( - 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 = domains.ExportRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.export_registration(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_export_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ExportRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.export_registration(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_export_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.export_registration( - 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_export_registration_flattened_error(): - client = DomainsClient( - 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.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_export_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.export_registration( - 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_export_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.DeleteRegistrationRequest, - dict, -]) -def test_delete_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - client.delete_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - -@pytest.mark.asyncio -async def test_delete_registration_async(transport: str = 'grpc_asyncio', request_type=domains.DeleteRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_registration_async_from_dict(): - await test_delete_registration_async(request_type=dict) - - -def test_delete_registration_field_headers(): - client = DomainsClient( - 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 = domains.DeleteRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_registration(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_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.DeleteRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_registration(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_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_registration( - 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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_registration( - 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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveAuthorizationCodeRequest, - dict, -]) -def test_retrieve_authorization_code(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode( - code='code_value', - ) - response = client.retrieve_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_retrieve_authorization_code_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - client.retrieve_authorization_code() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveAuthorizationCodeRequest): - client = DomainsAsyncClient( - 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.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( - code='code_value', - )) - response = await client.retrieve_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_async_from_dict(): - await test_retrieve_authorization_code_async(request_type=dict) - - -def test_retrieve_authorization_code_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - call.return_value = domains.AuthorizationCode() - client.retrieve_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - await client.retrieve_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_retrieve_authorization_code_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - - -def test_retrieve_authorization_code_flattened_error(): - client = DomainsClient( - 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.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ResetAuthorizationCodeRequest, - dict, -]) -def test_reset_authorization_code(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode( - code='code_value', - ) - response = client.reset_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_reset_authorization_code_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - client.reset_authorization_code() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - -@pytest.mark.asyncio -async def test_reset_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.ResetAuthorizationCodeRequest): - client = DomainsAsyncClient( - 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.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( - code='code_value', - )) - response = await client.reset_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -@pytest.mark.asyncio -async def test_reset_authorization_code_async_from_dict(): - await test_reset_authorization_code_async(request_type=dict) - - -def test_reset_authorization_code_field_headers(): - client = DomainsClient( - 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 = domains.ResetAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - call.return_value = domains.AuthorizationCode() - client.reset_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_reset_authorization_code_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ResetAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - await client.reset_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_reset_authorization_code_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.reset_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - - -def test_reset_authorization_code_flattened_error(): - client = DomainsClient( - 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.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - -@pytest.mark.asyncio -async def test_reset_authorization_code_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.reset_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_reset_authorization_code_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.SearchDomainsRequest, - dict, -]) -def test_search_domains_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.SearchDomainsResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.search_domains(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -def test_search_domains_rest_required_fields(request_type=domains.SearchDomainsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["query"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "query" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "query" in jsonified_request - assert jsonified_request["query"] == request_init["query"] - - jsonified_request["query"] = 'query_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("query", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "query" in jsonified_request - assert jsonified_request["query"] == 'query_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.SearchDomainsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.search_domains(request) - - expected_params = [ - ( - "query", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_search_domains_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.search_domains._get_unset_required_fields({}) - assert set(unset_fields) == (set(("query", )) & set(("query", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_domains_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_search_domains") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_search_domains") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.SearchDomainsRequest.pb(domains.SearchDomainsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.SearchDomainsResponse.to_json(domains.SearchDomainsResponse()) - - request = domains.SearchDomainsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.SearchDomainsResponse() - - client.search_domains(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_search_domains_rest_bad_request(transport: str = 'rest', request_type=domains.SearchDomainsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.search_domains(request) - - -def test_search_domains_rest_flattened(): - client = DomainsClient( - 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 = domains.SearchDomainsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_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 - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.search_domains(**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/{location=projects/*/locations/*}/registrations:searchDomains" % client.transport._host, args[1]) - - -def test_search_domains_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - - -def test_search_domains_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveRegisterParametersRequest, - dict, -]) -def test_retrieve_register_parameters_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.RetrieveRegisterParametersResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_register_parameters(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -def test_retrieve_register_parameters_rest_required_fields(request_type=domains.RetrieveRegisterParametersRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["domain_name"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "domainName" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == request_init["domain_name"] - - jsonified_request["domainName"] = 'domain_name_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("domain_name", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == 'domain_name_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.RetrieveRegisterParametersResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_register_parameters(request) - - expected_params = [ - ( - "domainName", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_register_parameters_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_register_parameters._get_unset_required_fields({}) - assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_register_parameters_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_register_parameters") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_register_parameters") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveRegisterParametersRequest.pb(domains.RetrieveRegisterParametersRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.RetrieveRegisterParametersResponse.to_json(domains.RetrieveRegisterParametersResponse()) - - request = domains.RetrieveRegisterParametersRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.RetrieveRegisterParametersResponse() - - client.retrieve_register_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_register_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveRegisterParametersRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_register_parameters(request) - - -def test_retrieve_register_parameters_rest_flattened(): - client = DomainsClient( - 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 = domains.RetrieveRegisterParametersResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_value', - domain_name='domain_name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_register_parameters(**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/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters" % client.transport._host, args[1]) - - -def test_retrieve_register_parameters_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -def test_retrieve_register_parameters_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RegisterDomainRequest, - dict, -]) -def test_register_domain_rest(request_type): - client = DomainsClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_domain(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_register_domain_rest_required_fields(request_type=domains.RegisterDomainRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_domain._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()).register_domain._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_domain(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_domain_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_domain._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_domain_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_register_domain") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_register_domain") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RegisterDomainRequest.pb(domains.RegisterDomainRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.RegisterDomainRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.register_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_domain_rest_bad_request(transport: str = 'rest', request_type=domains.RegisterDomainRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_domain(request) - - -def test_register_domain_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_domain(**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/*}/registrations:register" % client.transport._host, args[1]) - - -def test_register_domain_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - - -def test_register_domain_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveTransferParametersRequest, - dict, -]) -def test_retrieve_transfer_parameters_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.RetrieveTransferParametersResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_transfer_parameters(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -def test_retrieve_transfer_parameters_rest_required_fields(request_type=domains.RetrieveTransferParametersRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["domain_name"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "domainName" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == request_init["domain_name"] - - jsonified_request["domainName"] = 'domain_name_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("domain_name", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == 'domain_name_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.RetrieveTransferParametersResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_transfer_parameters(request) - - expected_params = [ - ( - "domainName", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_transfer_parameters_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_transfer_parameters._get_unset_required_fields({}) - assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_transfer_parameters_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_transfer_parameters") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_transfer_parameters") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveTransferParametersRequest.pb(domains.RetrieveTransferParametersRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.RetrieveTransferParametersResponse.to_json(domains.RetrieveTransferParametersResponse()) - - request = domains.RetrieveTransferParametersRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.RetrieveTransferParametersResponse() - - client.retrieve_transfer_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_transfer_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveTransferParametersRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_transfer_parameters(request) - - -def test_retrieve_transfer_parameters_rest_flattened(): - client = DomainsClient( - 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 = domains.RetrieveTransferParametersResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_value', - domain_name='domain_name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_transfer_parameters(**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/{location=projects/*/locations/*}/registrations:retrieveTransferParameters" % client.transport._host, args[1]) - - -def test_retrieve_transfer_parameters_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -def test_retrieve_transfer_parameters_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.TransferDomainRequest, - dict, -]) -def test_transfer_domain_rest(request_type): - client = DomainsClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.transfer_domain(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_transfer_domain_rest_required_fields(request_type=domains.TransferDomainRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).transfer_domain._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()).transfer_domain._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.transfer_domain(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_transfer_domain_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.transfer_domain._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_transfer_domain_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_transfer_domain") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_transfer_domain") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.TransferDomainRequest.pb(domains.TransferDomainRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.TransferDomainRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.transfer_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_transfer_domain_rest_bad_request(transport: str = 'rest', request_type=domains.TransferDomainRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.transfer_domain(request) - - -def test_transfer_domain_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.transfer_domain(**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/*}/registrations:transfer" % client.transport._host, args[1]) - - -def test_transfer_domain_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - - -def test_transfer_domain_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ListRegistrationsRequest, - dict, -]) -def test_list_registrations_rest(request_type): - client = DomainsClient( - 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 = domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_registrations(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_registrations_rest_required_fields(request_type=domains.ListRegistrationsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_registrations._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_registrations._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("filter", "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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.ListRegistrationsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_registrations(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_registrations_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_registrations._get_unset_required_fields({}) - assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_registrations_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_list_registrations") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_list_registrations") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ListRegistrationsRequest.pb(domains.ListRegistrationsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.ListRegistrationsResponse.to_json(domains.ListRegistrationsResponse()) - - request = domains.ListRegistrationsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.ListRegistrationsResponse() - - client.list_registrations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_registrations_rest_bad_request(transport: str = 'rest', request_type=domains.ListRegistrationsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_registrations(request) - - -def test_list_registrations_rest_flattened(): - client = DomainsClient( - 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 = domains.ListRegistrationsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_registrations(**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/*}/registrations" % client.transport._host, args[1]) - - -def test_list_registrations_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - - -def test_list_registrations_rest_pager(transport: str = 'rest'): - client = DomainsClient( - 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 = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(domains.ListRegistrationsResponse.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_registrations(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, domains.Registration) - for i in results) - - pages = list(client.list_registrations(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - domains.GetRegistrationRequest, - dict, -]) -def test_get_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/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 = domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_registration(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -def test_get_registration_rest_required_fields(request_type=domains.GetRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_registration._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_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.Registration() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_get_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_get_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.GetRegistrationRequest.pb(domains.GetRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.Registration.to_json(domains.Registration()) - - request = domains.GetRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.Registration() - - client.get_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_registration_rest_bad_request(transport: str = 'rest', request_type=domains.GetRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_registration(request) - - -def test_get_registration_rest_flattened(): - client = DomainsClient( - 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 = domains.Registration() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_registration(**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/*/registrations/*}" % client.transport._host, args[1]) - - -def test_get_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - - -def test_get_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.UpdateRegistrationRequest, - dict, -]) -def test_update_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_update_registration_rest_required_fields(request_type=domains.UpdateRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("update_mask", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "patch", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(("updateMask", )) & set(("updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_update_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_update_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.UpdateRegistrationRequest.pb(domains.UpdateRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.UpdateRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.update_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_registration_rest_bad_request(transport: str = 'rest', request_type=domains.UpdateRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_registration(request) - - -def test_update_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - - # get truthy value for each flattened field - mock_args = dict( - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_registration(**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/{registration.name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) - - -def test_update_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_update_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureManagementSettingsRequest, - dict, -]) -def test_configure_management_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_management_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_management_settings_rest_required_fields(request_type=domains.ConfigureManagementSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_management_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_management_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_management_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_management_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_management_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_management_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureManagementSettingsRequest.pb(domains.ConfigureManagementSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureManagementSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_management_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_management_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureManagementSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_management_settings(request) - - -def test_configure_management_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_management_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings" % client.transport._host, args[1]) - - -def test_configure_management_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_management_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureDnsSettingsRequest, - dict, -]) -def test_configure_dns_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_dns_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_dns_settings_rest_required_fields(request_type=domains.ConfigureDnsSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_dns_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_dns_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_dns_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_dns_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_dns_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_dns_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureDnsSettingsRequest.pb(domains.ConfigureDnsSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureDnsSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_dns_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_dns_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureDnsSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_dns_settings(request) - - -def test_configure_dns_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_dns_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings" % client.transport._host, args[1]) - - -def test_configure_dns_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_dns_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureContactSettingsRequest, - dict, -]) -def test_configure_contact_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_contact_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_contact_settings_rest_required_fields(request_type=domains.ConfigureContactSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_contact_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_contact_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_contact_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_contact_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_contact_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_contact_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureContactSettingsRequest.pb(domains.ConfigureContactSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureContactSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_contact_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_contact_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureContactSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_contact_settings(request) - - -def test_configure_contact_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_contact_settings(**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/{registration=projects/*/locations/*/registrations/*}:configureContactSettings" % client.transport._host, args[1]) - - -def test_configure_contact_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_contact_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ExportRegistrationRequest, - dict, -]) -def test_export_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.export_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_export_registration_rest_required_fields(request_type=domains.ExportRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).export_registration._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()).export_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.export_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_export_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.export_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_export_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_export_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_export_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ExportRegistrationRequest.pb(domains.ExportRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ExportRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.export_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_export_registration_rest_bad_request(transport: str = 'rest', request_type=domains.ExportRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.export_registration(request) - - -def test_export_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.export_registration(**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/*/registrations/*}:export" % client.transport._host, args[1]) - - -def test_export_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - - -def test_export_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.DeleteRegistrationRequest, - dict, -]) -def test_delete_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_delete_registration_rest_required_fields(request_type=domains.DeleteRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_registration._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_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_delete_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_delete_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.DeleteRegistrationRequest.pb(domains.DeleteRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.DeleteRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.delete_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_delete_registration_rest_bad_request(transport: str = 'rest', request_type=domains.DeleteRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_registration(request) - - -def test_delete_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_registration(**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/*/registrations/*}" % client.transport._host, args[1]) - - -def test_delete_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - - -def test_delete_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveAuthorizationCodeRequest, - dict, -]) -def test_retrieve_authorization_code_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( - code='code_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_authorization_code(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_retrieve_authorization_code_rest_required_fields(request_type=domains.RetrieveAuthorizationCodeRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.AuthorizationCode() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_authorization_code(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_authorization_code_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_authorization_code._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_authorization_code_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_authorization_code") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_authorization_code") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveAuthorizationCodeRequest.pb(domains.RetrieveAuthorizationCodeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) - - request = domains.RetrieveAuthorizationCodeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.AuthorizationCode() - - client.retrieve_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveAuthorizationCodeRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_authorization_code(request) - - -def test_retrieve_authorization_code_rest_flattened(): - client = DomainsClient( - 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 = domains.AuthorizationCode() - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_authorization_code(**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/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode" % client.transport._host, args[1]) - - -def test_retrieve_authorization_code_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - - -def test_retrieve_authorization_code_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ResetAuthorizationCodeRequest, - dict, -]) -def test_reset_authorization_code_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( - code='code_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.reset_authorization_code(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_reset_authorization_code_rest_required_fields(request_type=domains.ResetAuthorizationCodeRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.AuthorizationCode() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.reset_authorization_code(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_reset_authorization_code_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.reset_authorization_code._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_reset_authorization_code_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_reset_authorization_code") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_reset_authorization_code") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ResetAuthorizationCodeRequest.pb(domains.ResetAuthorizationCodeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) - - request = domains.ResetAuthorizationCodeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.AuthorizationCode() - - client.reset_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_reset_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.ResetAuthorizationCodeRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.reset_authorization_code(request) - - -def test_reset_authorization_code_rest_flattened(): - client = DomainsClient( - 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 = domains.AuthorizationCode() - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.reset_authorization_code(**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/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode" % client.transport._host, args[1]) - - -def test_reset_authorization_code_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - - -def test_reset_authorization_code_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = DomainsClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = DomainsClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = DomainsClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.DomainsGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - transports.DomainsRestTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = DomainsClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.DomainsGrpcTransport, - ) - -def test_domains_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.DomainsTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_domains_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.domains_v1.services.domains.transports.DomainsTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.DomainsTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'search_domains', - 'retrieve_register_parameters', - 'register_domain', - 'retrieve_transfer_parameters', - 'transfer_domain', - 'list_registrations', - 'get_registration', - 'update_registration', - 'configure_management_settings', - 'configure_dns_settings', - 'configure_contact_settings', - 'export_registration', - 'delete_registration', - 'retrieve_authorization_code', - 'reset_authorization_code', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_domains_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.domains_v1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.DomainsTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_domains_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.domains_v1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.DomainsTransport() - adc.assert_called_once() - - -def test_domains_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) - DomainsClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - ], -) -def test_domains_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - transports.DomainsRestTransport, - ], -) -def test_domains_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.DomainsGrpcTransport, grpc_helpers), - (transports.DomainsGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_domains_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( - "domains.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="domains.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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_domains_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.DomainsRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -def test_domains_rest_lro_client(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.AbstractOperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_domains_host_no_port(transport_name): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://domains.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_domains_host_with_port(transport_name): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'domains.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://domains.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_domains_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = DomainsClient( - credentials=creds1, - transport=transport_name, - ) - client2 = DomainsClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.search_domains._session - session2 = client2.transport.search_domains._session - assert session1 != session2 - session1 = client1.transport.retrieve_register_parameters._session - session2 = client2.transport.retrieve_register_parameters._session - assert session1 != session2 - session1 = client1.transport.register_domain._session - session2 = client2.transport.register_domain._session - assert session1 != session2 - session1 = client1.transport.retrieve_transfer_parameters._session - session2 = client2.transport.retrieve_transfer_parameters._session - assert session1 != session2 - session1 = client1.transport.transfer_domain._session - session2 = client2.transport.transfer_domain._session - assert session1 != session2 - session1 = client1.transport.list_registrations._session - session2 = client2.transport.list_registrations._session - assert session1 != session2 - session1 = client1.transport.get_registration._session - session2 = client2.transport.get_registration._session - assert session1 != session2 - session1 = client1.transport.update_registration._session - session2 = client2.transport.update_registration._session - assert session1 != session2 - session1 = client1.transport.configure_management_settings._session - session2 = client2.transport.configure_management_settings._session - assert session1 != session2 - session1 = client1.transport.configure_dns_settings._session - session2 = client2.transport.configure_dns_settings._session - assert session1 != session2 - session1 = client1.transport.configure_contact_settings._session - session2 = client2.transport.configure_contact_settings._session - assert session1 != session2 - session1 = client1.transport.export_registration._session - session2 = client2.transport.export_registration._session - assert session1 != session2 - session1 = client1.transport.delete_registration._session - session2 = client2.transport.delete_registration._session - assert session1 != session2 - session1 = client1.transport.retrieve_authorization_code._session - session2 = client2.transport.retrieve_authorization_code._session - assert session1 != session2 - session1 = client1.transport.reset_authorization_code._session - session2 = client2.transport.reset_authorization_code._session - assert session1 != session2 -def test_domains_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.DomainsGrpcTransport( - 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_domains_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.DomainsGrpcAsyncIOTransport( - 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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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_domains_grpc_lro_client(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_domains_grpc_lro_async_client(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsAsyncClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_registration_path(): - project = "squid" - location = "clam" - registration = "whelk" - expected = "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) - actual = DomainsClient.registration_path(project, location, registration) - assert expected == actual - - -def test_parse_registration_path(): - expected = { - "project": "octopus", - "location": "oyster", - "registration": "nudibranch", - } - path = DomainsClient.registration_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_registration_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = DomainsClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = DomainsClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = DomainsClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = DomainsClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = DomainsClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = DomainsClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = DomainsClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = DomainsClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.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 = DomainsClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = DomainsClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.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.DomainsTransport, '_prep_wrapped_messages') as prep: - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.DomainsTransport, '_prep_wrapped_messages') as prep: - transport_class = DomainsClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - - -def test_transport_close(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'rest', - 'grpc', - ] - for transport in transports: - client = DomainsClient( - 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", [ - (DomainsClient, transports.DomainsGrpcTransport), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) diff --git a/owl-bot-staging/v1beta1/.coveragerc b/owl-bot-staging/v1beta1/.coveragerc deleted file mode 100644 index 4cecf7e..0000000 --- a/owl-bot-staging/v1beta1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/domains/__init__.py - google/cloud/domains/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/v1beta1/.flake8 b/owl-bot-staging/v1beta1/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v1beta1/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/v1beta1/MANIFEST.in b/owl-bot-staging/v1beta1/MANIFEST.in deleted file mode 100644 index cc09b56..0000000 --- a/owl-bot-staging/v1beta1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/domains *.py -recursive-include google/cloud/domains_v1beta1 *.py diff --git a/owl-bot-staging/v1beta1/README.rst b/owl-bot-staging/v1beta1/README.rst deleted file mode 100644 index 6f21f3f..0000000 --- a/owl-bot-staging/v1beta1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Domains 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 Domains API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1beta1/docs/conf.py b/owl-bot-staging/v1beta1/docs/conf.py deleted file mode 100644 index 2345777..0000000 --- a/owl-bot-staging/v1beta1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-domains documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-cloud-domains" -copyright = u"2022, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-domains-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-domains.tex", - u"google-cloud-domains 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-domains", - u"Google Cloud Domains 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-domains", - u"google-cloud-domains Documentation", - author, - "google-cloud-domains", - "GAPIC library for Google Cloud Domains API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst deleted file mode 100644 index 13d490a..0000000 --- a/owl-bot-staging/v1beta1/docs/domains_v1beta1/domains.rst +++ /dev/null @@ -1,10 +0,0 @@ -Domains -------------------------- - -.. automodule:: google.cloud.domains_v1beta1.services.domains - :members: - :inherited-members: - -.. automodule:: google.cloud.domains_v1beta1.services.domains.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst deleted file mode 100644 index 3e3faa8..0000000 --- a/owl-bot-staging/v1beta1/docs/domains_v1beta1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Domains v1beta1 API -============================================= -.. toctree:: - :maxdepth: 2 - - domains diff --git a/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst b/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst deleted file mode 100644 index dbbe2b8..0000000 --- a/owl-bot-staging/v1beta1/docs/domains_v1beta1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Domains v1beta1 API -========================================== - -.. automodule:: google.cloud.domains_v1beta1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v1beta1/docs/index.rst b/owl-bot-staging/v1beta1/docs/index.rst deleted file mode 100644 index 0011907..0000000 --- a/owl-bot-staging/v1beta1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - domains_v1beta1/services - domains_v1beta1/types diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py deleted file mode 100644 index 0204ad4..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains/__init__.py +++ /dev/null @@ -1,89 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.domains import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.domains_v1beta1.services.domains.client import DomainsClient -from google.cloud.domains_v1beta1.services.domains.async_client import DomainsAsyncClient - -from google.cloud.domains_v1beta1.types.domains import AuthorizationCode -from google.cloud.domains_v1beta1.types.domains import ConfigureContactSettingsRequest -from google.cloud.domains_v1beta1.types.domains import ConfigureDnsSettingsRequest -from google.cloud.domains_v1beta1.types.domains import ConfigureManagementSettingsRequest -from google.cloud.domains_v1beta1.types.domains import ContactSettings -from google.cloud.domains_v1beta1.types.domains import DeleteRegistrationRequest -from google.cloud.domains_v1beta1.types.domains import DnsSettings -from google.cloud.domains_v1beta1.types.domains import ExportRegistrationRequest -from google.cloud.domains_v1beta1.types.domains import GetRegistrationRequest -from google.cloud.domains_v1beta1.types.domains import ListRegistrationsRequest -from google.cloud.domains_v1beta1.types.domains import ListRegistrationsResponse -from google.cloud.domains_v1beta1.types.domains import ManagementSettings -from google.cloud.domains_v1beta1.types.domains import OperationMetadata -from google.cloud.domains_v1beta1.types.domains import RegisterDomainRequest -from google.cloud.domains_v1beta1.types.domains import RegisterParameters -from google.cloud.domains_v1beta1.types.domains import Registration -from google.cloud.domains_v1beta1.types.domains import ResetAuthorizationCodeRequest -from google.cloud.domains_v1beta1.types.domains import RetrieveAuthorizationCodeRequest -from google.cloud.domains_v1beta1.types.domains import RetrieveRegisterParametersRequest -from google.cloud.domains_v1beta1.types.domains import RetrieveRegisterParametersResponse -from google.cloud.domains_v1beta1.types.domains import RetrieveTransferParametersRequest -from google.cloud.domains_v1beta1.types.domains import RetrieveTransferParametersResponse -from google.cloud.domains_v1beta1.types.domains import SearchDomainsRequest -from google.cloud.domains_v1beta1.types.domains import SearchDomainsResponse -from google.cloud.domains_v1beta1.types.domains import TransferDomainRequest -from google.cloud.domains_v1beta1.types.domains import TransferParameters -from google.cloud.domains_v1beta1.types.domains import UpdateRegistrationRequest -from google.cloud.domains_v1beta1.types.domains import ContactNotice -from google.cloud.domains_v1beta1.types.domains import ContactPrivacy -from google.cloud.domains_v1beta1.types.domains import DomainNotice -from google.cloud.domains_v1beta1.types.domains import TransferLockState - -__all__ = ('DomainsClient', - 'DomainsAsyncClient', - 'AuthorizationCode', - 'ConfigureContactSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureManagementSettingsRequest', - 'ContactSettings', - 'DeleteRegistrationRequest', - 'DnsSettings', - 'ExportRegistrationRequest', - 'GetRegistrationRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'ManagementSettings', - 'OperationMetadata', - 'RegisterDomainRequest', - 'RegisterParameters', - 'Registration', - 'ResetAuthorizationCodeRequest', - 'RetrieveAuthorizationCodeRequest', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'TransferDomainRequest', - 'TransferParameters', - 'UpdateRegistrationRequest', - 'ContactNotice', - 'ContactPrivacy', - 'DomainNotice', - 'TransferLockState', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains/py.typed b/owl-bot-staging/v1beta1/google/cloud/domains/py.typed deleted file mode 100644 index b463d6c..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py deleted file mode 100644 index f0fc498..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/__init__.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.domains_v1beta1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.domains import DomainsClient -from .services.domains import DomainsAsyncClient - -from .types.domains import AuthorizationCode -from .types.domains import ConfigureContactSettingsRequest -from .types.domains import ConfigureDnsSettingsRequest -from .types.domains import ConfigureManagementSettingsRequest -from .types.domains import ContactSettings -from .types.domains import DeleteRegistrationRequest -from .types.domains import DnsSettings -from .types.domains import ExportRegistrationRequest -from .types.domains import GetRegistrationRequest -from .types.domains import ListRegistrationsRequest -from .types.domains import ListRegistrationsResponse -from .types.domains import ManagementSettings -from .types.domains import OperationMetadata -from .types.domains import RegisterDomainRequest -from .types.domains import RegisterParameters -from .types.domains import Registration -from .types.domains import ResetAuthorizationCodeRequest -from .types.domains import RetrieveAuthorizationCodeRequest -from .types.domains import RetrieveRegisterParametersRequest -from .types.domains import RetrieveRegisterParametersResponse -from .types.domains import RetrieveTransferParametersRequest -from .types.domains import RetrieveTransferParametersResponse -from .types.domains import SearchDomainsRequest -from .types.domains import SearchDomainsResponse -from .types.domains import TransferDomainRequest -from .types.domains import TransferParameters -from .types.domains import UpdateRegistrationRequest -from .types.domains import ContactNotice -from .types.domains import ContactPrivacy -from .types.domains import DomainNotice -from .types.domains import TransferLockState - -__all__ = ( - 'DomainsAsyncClient', -'AuthorizationCode', -'ConfigureContactSettingsRequest', -'ConfigureDnsSettingsRequest', -'ConfigureManagementSettingsRequest', -'ContactNotice', -'ContactPrivacy', -'ContactSettings', -'DeleteRegistrationRequest', -'DnsSettings', -'DomainNotice', -'DomainsClient', -'ExportRegistrationRequest', -'GetRegistrationRequest', -'ListRegistrationsRequest', -'ListRegistrationsResponse', -'ManagementSettings', -'OperationMetadata', -'RegisterDomainRequest', -'RegisterParameters', -'Registration', -'ResetAuthorizationCodeRequest', -'RetrieveAuthorizationCodeRequest', -'RetrieveRegisterParametersRequest', -'RetrieveRegisterParametersResponse', -'RetrieveTransferParametersRequest', -'RetrieveTransferParametersResponse', -'SearchDomainsRequest', -'SearchDomainsResponse', -'TransferDomainRequest', -'TransferLockState', -'TransferParameters', -'UpdateRegistrationRequest', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json deleted file mode 100644 index fa29a8d..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_metadata.json +++ /dev/null @@ -1,253 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.domains_v1beta1", - "protoPackage": "google.cloud.domains.v1beta1", - "schema": "1.0", - "services": { - "Domains": { - "clients": { - "grpc": { - "libraryClient": "DomainsClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - }, - "grpc-async": { - "libraryClient": "DomainsAsyncClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - }, - "rest": { - "libraryClient": "DomainsClient", - "rpcs": { - "ConfigureContactSettings": { - "methods": [ - "configure_contact_settings" - ] - }, - "ConfigureDnsSettings": { - "methods": [ - "configure_dns_settings" - ] - }, - "ConfigureManagementSettings": { - "methods": [ - "configure_management_settings" - ] - }, - "DeleteRegistration": { - "methods": [ - "delete_registration" - ] - }, - "ExportRegistration": { - "methods": [ - "export_registration" - ] - }, - "GetRegistration": { - "methods": [ - "get_registration" - ] - }, - "ListRegistrations": { - "methods": [ - "list_registrations" - ] - }, - "RegisterDomain": { - "methods": [ - "register_domain" - ] - }, - "ResetAuthorizationCode": { - "methods": [ - "reset_authorization_code" - ] - }, - "RetrieveAuthorizationCode": { - "methods": [ - "retrieve_authorization_code" - ] - }, - "RetrieveRegisterParameters": { - "methods": [ - "retrieve_register_parameters" - ] - }, - "RetrieveTransferParameters": { - "methods": [ - "retrieve_transfer_parameters" - ] - }, - "SearchDomains": { - "methods": [ - "search_domains" - ] - }, - "TransferDomain": { - "methods": [ - "transfer_domain" - ] - }, - "UpdateRegistration": { - "methods": [ - "update_registration" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed deleted file mode 100644 index b463d6c..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-domains package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py deleted file mode 100644 index e8e1c38..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py deleted file mode 100644 index 28d2584..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import DomainsClient -from .async_client import DomainsAsyncClient - -__all__ = ( - 'DomainsClient', - 'DomainsAsyncClient', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py deleted file mode 100644 index 8e5e81f..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/async_client.py +++ /dev/null @@ -1,2284 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.domains_v1beta1 import gapic_version as package_version - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.domains_v1beta1.services.domains import pagers -from google.cloud.domains_v1beta1.types import domains -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport -from .client import DomainsClient - - -class DomainsAsyncClient: - """The Cloud Domains API enables management and configuration of - domain names. - """ - - _client: DomainsClient - - DEFAULT_ENDPOINT = DomainsClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = DomainsClient.DEFAULT_MTLS_ENDPOINT - - registration_path = staticmethod(DomainsClient.registration_path) - parse_registration_path = staticmethod(DomainsClient.parse_registration_path) - common_billing_account_path = staticmethod(DomainsClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(DomainsClient.parse_common_billing_account_path) - common_folder_path = staticmethod(DomainsClient.common_folder_path) - parse_common_folder_path = staticmethod(DomainsClient.parse_common_folder_path) - common_organization_path = staticmethod(DomainsClient.common_organization_path) - parse_common_organization_path = staticmethod(DomainsClient.parse_common_organization_path) - common_project_path = staticmethod(DomainsClient.common_project_path) - parse_common_project_path = staticmethod(DomainsClient.parse_common_project_path) - common_location_path = staticmethod(DomainsClient.common_location_path) - parse_common_location_path = staticmethod(DomainsClient.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: - DomainsAsyncClient: The constructed client. - """ - return DomainsClient.from_service_account_info.__func__(DomainsAsyncClient, 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: - DomainsAsyncClient: The constructed client. - """ - return DomainsClient.from_service_account_file.__func__(DomainsAsyncClient, 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 DomainsClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> DomainsTransport: - """Returns the transport used by the client instance. - - Returns: - DomainsTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(DomainsClient).get_transport_class, type(DomainsClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, DomainsTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the domains client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.DomainsTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = DomainsClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def search_domains(self, - request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, - *, - location: 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, str]] = (), - ) -> domains.SearchDomainsResponse: - r"""Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - .. 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 domains_v1beta1 - - async def sample_search_domains(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = await client.search_domains(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]]): - The request object. Request for the ``SearchDomains`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Required. String used to search for - available domain names. - - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.SearchDomainsResponse: - Response for the SearchDomains method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, query]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.SearchDomainsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.search_domains, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def retrieve_register_parameters(self, - request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - .. 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 domains_v1beta1 - - async def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]]): - The request object. Request for the ``RetrieveRegisterParameters`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (:class:`str`): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse: - Response for the RetrieveRegisterParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveRegisterParametersRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_register_parameters, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def register_domain(self, - request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - .. 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 domains_v1beta1 - - async def sample_register_domain(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]]): - The request object. Request for the ``RegisterDomain`` method. - parent (:class:`str`): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (:class:`google.cloud.domains_v1beta1.types.Registration`): - Required. The complete ``Registration`` resource to be - created. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (:class:`google.type.money_pb2.Money`): - Required. Yearly price to register or - renew the domain. The value that should - be put here can be obtained from - RetrieveRegisterParameters or - SearchDomains calls. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RegisterDomainRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.register_domain, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def retrieve_transfer_parameters(self, - request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveTransferParametersResponse: - r"""Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - .. 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 domains_v1beta1 - - async def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]]): - The request object. Request for the ``RetrieveTransferParameters`` method. - location (:class:`str`): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (:class:`str`): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse: - Response for the RetrieveTransferParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveTransferParametersRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_transfer_parameters, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def transfer_domain(self, - request: Optional[Union[domains.TransferDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - authorization_code: Optional[domains.AuthorizationCode] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - .. 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 domains_v1beta1 - - async def sample_transfer_domain(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]]): - The request object. Request for the ``TransferDomain`` method. - parent (:class:`str`): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (:class:`google.cloud.domains_v1beta1.types.Registration`): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to - import the domain's current DNS configuration from its - current registrar. Use this option only if you are sure - that the domain's current DNS service does not cease - upon transfer, as is often the case for DNS services - provided for free by the registrar. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (:class:`google.type.money_pb2.Money`): - Required. Acknowledgement of the price to transfer or - renew the domain for one year. Call - ``RetrieveTransferParameters`` to obtain the price, - which you must acknowledge. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - authorization_code (:class:`google.cloud.domains_v1beta1.types.AuthorizationCode`): - The domain's transfer authorization - code. You can obtain this from the - domain's current registrar. - - This corresponds to the ``authorization_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price, authorization_code]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.TransferDomainRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - if authorization_code is not None: - request.authorization_code = authorization_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.transfer_domain, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def list_registrations(self, - request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRegistrationsAsyncPager: - r"""Lists the ``Registration`` resources in a 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 domains_v1beta1 - - async def sample_list_registrations(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]]): - The request object. Request for the ``ListRegistrations`` method. - parent (:class:`str`): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager: - Response for the ListRegistrations method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ListRegistrationsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_registrations, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListRegistrationsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_registration(self, - request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.Registration: - r"""Gets the details of a ``Registration`` 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 domains_v1beta1 - - async def sample_get_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_registration(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]]): - The request object. Request for the ``GetRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to get, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.Registration: - The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.GetRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_registration(self, - request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, - *, - registration: Optional[domains.Registration] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - .. 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 domains_v1beta1 - - async def sample_update_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]]): - The request object. Request for the ``UpdateRegistration`` method. - registration (:class:`google.cloud.domains_v1beta1.types.Registration`): - Fields of the ``Registration`` to update. - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the labels are being updated, the ``update_mask`` is - ``"labels"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.UpdateRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration.name", request.registration.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_management_settings(self, - request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - management_settings: Optional[domains.ManagementSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s management settings. - - .. 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 domains_v1beta1 - - async def sample_configure_management_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]]): - The request object. Request for the ``ConfigureManagementSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - management settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - management_settings (:class:`google.cloud.domains_v1beta1.types.ManagementSettings`): - Fields of the ``ManagementSettings`` to update. - This corresponds to the ``management_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the transfer lock is being updated, the ``update_mask`` - is ``"transfer_lock_state"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, management_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureManagementSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if management_settings is not None: - request.management_settings = management_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_management_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_dns_settings(self, - request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - dns_settings: Optional[domains.DnsSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s DNS settings. - - .. 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 domains_v1beta1 - - async def sample_configure_dns_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]]): - The request object. Request for the ``ConfigureDnsSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - dns_settings (:class:`google.cloud.domains_v1beta1.types.DnsSettings`): - Fields of the ``DnsSettings`` to update. - This corresponds to the ``dns_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the name servers are being updated for an existing - Custom DNS configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains - DNS configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, dns_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureDnsSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if dns_settings is not None: - request.dns_settings = dns_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_dns_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def configure_contact_settings(self, - request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - contact_settings: Optional[domains.ContactSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - .. 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 domains_v1beta1 - - async def sample_configure_contact_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]]): - The request object. Request for the ``ConfigureContactSettings`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact_settings (:class:`google.cloud.domains_v1beta1.types.ContactSettings`): - Fields of the ``ContactSettings`` to update. - This corresponds to the ``contact_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the registrant contact is being updated, the - ``update_mask`` is ``"registrant_contact"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, contact_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ConfigureContactSettingsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if contact_settings is not None: - request.contact_settings = contact_settings - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.configure_contact_settings, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def export_registration(self, - request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1beta1 - - async def sample_export_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]]): - The request object. Request for the ``ExportRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to export, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ExportRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.export_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def delete_registration(self, - request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1beta1 - - async def sample_delete_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]]): - The request object. Request for the ``DeleteRegistration`` method. - name (:class:`str`): - Required. The name of the ``Registration`` to delete, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.DeleteRegistrationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_registration, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - empty_pb2.Empty, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - async def retrieve_authorization_code(self, - request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1beta1 - - async def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]]): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.RetrieveAuthorizationCodeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_authorization_code, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def reset_authorization_code(self, - request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1beta1 - - async def sample_reset_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.reset_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]]): - The request object. Request for the ``ResetAuthorizationCode`` method. - registration (:class:`str`): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = domains.ResetAuthorizationCodeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.reset_authorization_code, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "DomainsAsyncClient", -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py deleted file mode 100644 index 230404f..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/client.py +++ /dev/null @@ -1,2488 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.domains_v1beta1 import gapic_version as package_version - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.domains_v1beta1.services.domains import pagers -from google.cloud.domains_v1beta1.types import domains -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from .transports.base import DomainsTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import DomainsGrpcTransport -from .transports.grpc_asyncio import DomainsGrpcAsyncIOTransport -from .transports.rest import DomainsRestTransport - - -class DomainsClientMeta(type): - """Metaclass for the Domains 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[DomainsTransport]] - _transport_registry["grpc"] = DomainsGrpcTransport - _transport_registry["grpc_asyncio"] = DomainsGrpcAsyncIOTransport - _transport_registry["rest"] = DomainsRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[DomainsTransport]: - """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 DomainsClient(metaclass=DomainsClientMeta): - """The Cloud Domains API enables management and configuration of - domain names. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "domains.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - DomainsClient: 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: - DomainsClient: 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) -> DomainsTransport: - """Returns the transport used by the client instance. - - Returns: - DomainsTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def registration_path(project: str,location: str,registration: str,) -> str: - """Returns a fully-qualified registration string.""" - return "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) - - @staticmethod - def parse_registration_path(path: str) -> Dict[str,str]: - """Parses a registration path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/registrations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, DomainsTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the domains client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, DomainsTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - client_options = cast(client_options_lib.ClientOptions, client_options) - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, DomainsTransport): - # transport is a DomainsTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def search_domains(self, - request: Optional[Union[domains.SearchDomainsRequest, dict]] = None, - *, - location: 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, str]] = (), - ) -> domains.SearchDomainsResponse: - r"""Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - .. 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 domains_v1beta1 - - def sample_search_domains(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = client.search_domains(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.SearchDomainsRequest, dict]): - The request object. Request for the ``SearchDomains`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Required. String used to search for - available domain names. - - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.SearchDomainsResponse: - Response for the SearchDomains method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, query]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.SearchDomainsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.SearchDomainsRequest): - request = domains.SearchDomainsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - 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_domains] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def retrieve_register_parameters(self, - request: Optional[Union[domains.RetrieveRegisterParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - .. 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 domains_v1beta1 - - def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest, dict]): - The request object. Request for the ``RetrieveRegisterParameters`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (str): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse: - Response for the RetrieveRegisterParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveRegisterParametersRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveRegisterParametersRequest): - request = domains.RetrieveRegisterParametersRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_register_parameters] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def register_domain(self, - request: Optional[Union[domains.RegisterDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - .. 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 domains_v1beta1 - - def sample_register_domain(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.RegisterDomainRequest, dict]): - The request object. Request for the ``RegisterDomain`` method. - parent (str): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (google.cloud.domains_v1beta1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (google.type.money_pb2.Money): - Required. Yearly price to register or - renew the domain. The value that should - be put here can be obtained from - RetrieveRegisterParameters or - SearchDomains calls. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RegisterDomainRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RegisterDomainRequest): - request = domains.RegisterDomainRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.register_domain] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def retrieve_transfer_parameters(self, - request: Optional[Union[domains.RetrieveTransferParametersRequest, dict]] = None, - *, - location: Optional[str] = None, - domain_name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.RetrieveTransferParametersResponse: - r"""Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - .. 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 domains_v1beta1 - - def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest, dict]): - The request object. Request for the ``RetrieveTransferParameters`` method. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - - This corresponds to the ``location`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - domain_name (str): - Required. The domain name. Unicode - domain names must be expressed in - Punycode format. - - This corresponds to the ``domain_name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse: - Response for the RetrieveTransferParameters method. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([location, domain_name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveTransferParametersRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveTransferParametersRequest): - request = domains.RetrieveTransferParametersRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if location is not None: - request.location = location - if domain_name is not None: - request.domain_name = domain_name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_transfer_parameters] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("location", request.location), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def transfer_domain(self, - request: Optional[Union[domains.TransferDomainRequest, dict]] = None, - *, - parent: Optional[str] = None, - registration: Optional[domains.Registration] = None, - yearly_price: Optional[money_pb2.Money] = None, - authorization_code: Optional[domains.AuthorizationCode] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - .. 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 domains_v1beta1 - - def sample_transfer_domain(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.TransferDomainRequest, dict]): - The request object. Request for the ``TransferDomain`` method. - parent (str): - Required. The parent resource of the ``Registration``. - Must be in the format ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - registration (google.cloud.domains_v1beta1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to - import the domain's current DNS configuration from its - current registrar. Use this option only if you are sure - that the domain's current DNS service does not cease - upon transfer, as is often the case for DNS services - provided for free by the registrar. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - yearly_price (google.type.money_pb2.Money): - Required. Acknowledgement of the price to transfer or - renew the domain for one year. Call - ``RetrieveTransferParameters`` to obtain the price, - which you must acknowledge. - - This corresponds to the ``yearly_price`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - authorization_code (google.cloud.domains_v1beta1.types.AuthorizationCode): - The domain's transfer authorization - code. You can obtain this from the - domain's current registrar. - - This corresponds to the ``authorization_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, registration, yearly_price, authorization_code]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.TransferDomainRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.TransferDomainRequest): - request = domains.TransferDomainRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if registration is not None: - request.registration = registration - if yearly_price is not None: - request.yearly_price = yearly_price - if authorization_code is not None: - request.authorization_code = authorization_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.transfer_domain] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def list_registrations(self, - request: Optional[Union[domains.ListRegistrationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRegistrationsPager: - r"""Lists the ``Registration`` resources in a 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 domains_v1beta1 - - def sample_list_registrations(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ListRegistrationsRequest, dict]): - The request object. Request for the ``ListRegistrations`` method. - parent (str): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager: - Response for the ListRegistrations method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ListRegistrationsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ListRegistrationsRequest): - request = domains.ListRegistrationsRequest(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_registrations] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListRegistrationsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_registration(self, - request: Optional[Union[domains.GetRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.Registration: - r"""Gets the details of a ``Registration`` 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 domains_v1beta1 - - def sample_get_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = client.get_registration(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.GetRegistrationRequest, dict]): - The request object. Request for the ``GetRegistration`` method. - name (str): - Required. The name of the ``Registration`` to get, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.Registration: - The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.GetRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.GetRegistrationRequest): - request = domains.GetRegistrationRequest(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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_registration(self, - request: Optional[Union[domains.UpdateRegistrationRequest, dict]] = None, - *, - registration: Optional[domains.Registration] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - .. 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 domains_v1beta1 - - def sample_update_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.UpdateRegistrationRequest, dict]): - The request object. Request for the ``UpdateRegistration`` method. - registration (google.cloud.domains_v1beta1.types.Registration): - Fields of the ``Registration`` to update. - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the labels are being updated, the ``update_mask`` is - ``"labels"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.UpdateRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.UpdateRegistrationRequest): - request = domains.UpdateRegistrationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - 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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration.name", request.registration.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_management_settings(self, - request: Optional[Union[domains.ConfigureManagementSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - management_settings: Optional[domains.ManagementSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s management settings. - - .. 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 domains_v1beta1 - - def sample_configure_management_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest, dict]): - The request object. Request for the ``ConfigureManagementSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose - management settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): - Fields of the ``ManagementSettings`` to update. - This corresponds to the ``management_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the transfer lock is being updated, the ``update_mask`` - is ``"transfer_lock_state"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, management_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureManagementSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureManagementSettingsRequest): - request = domains.ConfigureManagementSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if management_settings is not None: - request.management_settings = management_settings - 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.configure_management_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_dns_settings(self, - request: Optional[Union[domains.ConfigureDnsSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - dns_settings: Optional[domains.DnsSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s DNS settings. - - .. 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 domains_v1beta1 - - def sample_configure_dns_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest, dict]): - The request object. Request for the ``ConfigureDnsSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): - Fields of the ``DnsSettings`` to update. - This corresponds to the ``dns_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the name servers are being updated for an existing - Custom DNS configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains - DNS configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, dns_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureDnsSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureDnsSettingsRequest): - request = domains.ConfigureDnsSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if dns_settings is not None: - request.dns_settings = dns_settings - 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.configure_dns_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def configure_contact_settings(self, - request: Optional[Union[domains.ConfigureContactSettingsRequest, dict]] = None, - *, - registration: Optional[str] = None, - contact_settings: Optional[domains.ContactSettings] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - .. 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 domains_v1beta1 - - def sample_configure_contact_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest, dict]): - The request object. Request for the ``ConfigureContactSettings`` method. - registration (str): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): - Fields of the ``ContactSettings`` to update. - This corresponds to the ``contact_settings`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to - update as a comma-separated list. For example, if only - the registrant contact is being updated, the - ``update_mask`` is ``"registrant_contact"``. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration, contact_settings, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ConfigureContactSettingsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ConfigureContactSettingsRequest): - request = domains.ConfigureContactSettingsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - if contact_settings is not None: - request.contact_settings = contact_settings - 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.configure_contact_settings] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def export_registration(self, - request: Optional[Union[domains.ExportRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1beta1 - - def sample_export_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ExportRegistrationRequest, dict]): - The request object. Request for the ``ExportRegistration`` method. - name (str): - Required. The name of the ``Registration`` to export, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.domains_v1beta1.types.Registration` The Registration resource facilitates managing and configuring domain name - registrations. - - There are several ways to create a new Registration - resource: - - To create a new Registration resource, find a - suitable domain name by calling the SearchDomains - method with a query to see available domain name - options. After choosing a name, call - RetrieveRegisterParameters to ensure availability and - obtain information like pricing, which is needed to - build a call to RegisterDomain. - - Another way to create a new Registration is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the - domain for transfer and retrieve the domain's - transfer authorization code. Then call - RetrieveTransferParameters to confirm that the domain - is unlocked and to get values needed to build a call - to TransferDomain. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ExportRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ExportRegistrationRequest): - request = domains.ExportRegistrationRequest(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.export_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - domains.Registration, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def delete_registration(self, - request: Optional[Union[domains.DeleteRegistrationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - .. 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 domains_v1beta1 - - def sample_delete_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.DeleteRegistrationRequest, dict]): - The request object. Request for the ``DeleteRegistration`` method. - name (str): - Required. The name of the ``Registration`` to delete, in - the format ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.DeleteRegistrationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.DeleteRegistrationRequest): - request = domains.DeleteRegistrationRequest(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_registration] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - empty_pb2.Empty, - metadata_type=domains.OperationMetadata, - ) - - # Done; return the response. - return response - - def retrieve_authorization_code(self, - request: Optional[Union[domains.RetrieveAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1beta1 - - def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest, dict]): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.RetrieveAuthorizationCodeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.RetrieveAuthorizationCodeRequest): - request = domains.RetrieveAuthorizationCodeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_authorization_code] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def reset_authorization_code(self, - request: Optional[Union[domains.ResetAuthorizationCodeRequest, dict]] = None, - *, - registration: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> domains.AuthorizationCode: - r"""Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - .. 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 domains_v1beta1 - - def sample_reset_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.reset_authorization_code(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest, dict]): - The request object. Request for the ``ResetAuthorizationCode`` method. - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - - This corresponds to the ``registration`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.domains_v1beta1.types.AuthorizationCode: - Defines an authorization code. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([registration]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a domains.ResetAuthorizationCodeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, domains.ResetAuthorizationCodeRequest): - request = domains.ResetAuthorizationCodeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if registration is not None: - request.registration = registration - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.reset_authorization_code] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("registration", request.registration), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "DomainsClient": - 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__) - - -__all__ = ( - "DomainsClient", -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py deleted file mode 100644 index 32e20ac..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/pagers.py +++ /dev/null @@ -1,139 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.domains_v1beta1.types import domains - - -class ListRegistrationsPager: - """A pager for iterating through ``list_registrations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``registrations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRegistrations`` requests and continue to iterate - through the ``registrations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` - 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[..., domains.ListRegistrationsResponse], - request: domains.ListRegistrationsRequest, - response: domains.ListRegistrationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.domains_v1beta1.types.ListRegistrationsRequest): - The initial request object. - response (google.cloud.domains_v1beta1.types.ListRegistrationsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = domains.ListRegistrationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[domains.ListRegistrationsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[domains.Registration]: - for page in self.pages: - yield from page.registrations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRegistrationsAsyncPager: - """A pager for iterating through ``list_registrations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``registrations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRegistrations`` requests and continue to iterate - through the ``registrations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.domains_v1beta1.types.ListRegistrationsResponse` - 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[domains.ListRegistrationsResponse]], - request: domains.ListRegistrationsRequest, - response: domains.ListRegistrationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.domains_v1beta1.types.ListRegistrationsRequest): - The initial request object. - response (google.cloud.domains_v1beta1.types.ListRegistrationsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = domains.ListRegistrationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[domains.ListRegistrationsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[domains.Registration]: - async def async_generator(): - async for page in self.pages: - for response in page.registrations: - 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/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py deleted file mode 100644 index 8648a03..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import DomainsTransport -from .grpc import DomainsGrpcTransport -from .grpc_asyncio import DomainsGrpcAsyncIOTransport -from .rest import DomainsRestTransport -from .rest import DomainsRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[DomainsTransport]] -_transport_registry['grpc'] = DomainsGrpcTransport -_transport_registry['grpc_asyncio'] = DomainsGrpcAsyncIOTransport -_transport_registry['rest'] = DomainsRestTransport - -__all__ = ( - 'DomainsTransport', - 'DomainsGrpcTransport', - 'DomainsGrpcAsyncIOTransport', - 'DomainsRestTransport', - 'DomainsRestInterceptor', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py deleted file mode 100644 index 3d2265d..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/base.py +++ /dev/null @@ -1,351 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union - -from google.cloud.domains_v1beta1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.domains_v1beta1.types import domains -from google.longrunning import operations_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class DomainsTransport(abc.ABC): - """Abstract transport class for Domains.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'domains.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.search_domains: gapic_v1.method.wrap_method( - self.search_domains, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_register_parameters: gapic_v1.method.wrap_method( - self.retrieve_register_parameters, - default_timeout=None, - client_info=client_info, - ), - self.register_domain: gapic_v1.method.wrap_method( - self.register_domain, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_transfer_parameters: gapic_v1.method.wrap_method( - self.retrieve_transfer_parameters, - default_timeout=None, - client_info=client_info, - ), - self.transfer_domain: gapic_v1.method.wrap_method( - self.transfer_domain, - default_timeout=None, - client_info=client_info, - ), - self.list_registrations: gapic_v1.method.wrap_method( - self.list_registrations, - default_timeout=None, - client_info=client_info, - ), - self.get_registration: gapic_v1.method.wrap_method( - self.get_registration, - default_timeout=None, - client_info=client_info, - ), - self.update_registration: gapic_v1.method.wrap_method( - self.update_registration, - default_timeout=None, - client_info=client_info, - ), - self.configure_management_settings: gapic_v1.method.wrap_method( - self.configure_management_settings, - default_timeout=None, - client_info=client_info, - ), - self.configure_dns_settings: gapic_v1.method.wrap_method( - self.configure_dns_settings, - default_timeout=None, - client_info=client_info, - ), - self.configure_contact_settings: gapic_v1.method.wrap_method( - self.configure_contact_settings, - default_timeout=None, - client_info=client_info, - ), - self.export_registration: gapic_v1.method.wrap_method( - self.export_registration, - default_timeout=None, - client_info=client_info, - ), - self.delete_registration: gapic_v1.method.wrap_method( - self.delete_registration, - default_timeout=None, - client_info=client_info, - ), - self.retrieve_authorization_code: gapic_v1.method.wrap_method( - self.retrieve_authorization_code, - default_timeout=None, - client_info=client_info, - ), - self.reset_authorization_code: gapic_v1.method.wrap_method( - self.reset_authorization_code, - default_timeout=None, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def operations_client(self): - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - Union[ - domains.SearchDomainsResponse, - Awaitable[domains.SearchDomainsResponse] - ]]: - raise NotImplementedError() - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - Union[ - domains.RetrieveRegisterParametersResponse, - Awaitable[domains.RetrieveRegisterParametersResponse] - ]]: - raise NotImplementedError() - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - Union[ - domains.RetrieveTransferParametersResponse, - Awaitable[domains.RetrieveTransferParametersResponse] - ]]: - raise NotImplementedError() - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - Union[ - domains.ListRegistrationsResponse, - Awaitable[domains.ListRegistrationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - Union[ - domains.Registration, - Awaitable[domains.Registration] - ]]: - raise NotImplementedError() - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - Union[ - domains.AuthorizationCode, - Awaitable[domains.AuthorizationCode] - ]]: - raise NotImplementedError() - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - Union[ - domains.AuthorizationCode, - Awaitable[domains.AuthorizationCode] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'DomainsTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py deleted file mode 100644 index e722cf5..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc.py +++ /dev/null @@ -1,742 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import operations_v1 -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.domains_v1beta1.types import domains -from google.longrunning import operations_pb2 # type: ignore -from .base import DomainsTransport, DEFAULT_CLIENT_INFO - - -class DomainsGrpcTransport(DomainsTransport): - """gRPC backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client: Optional[operations_v1.OperationsClient] = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - domains.SearchDomainsResponse]: - r"""Return a callable for the search domains method over gRPC. - - Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - Returns: - Callable[[~.SearchDomainsRequest], - ~.SearchDomainsResponse]: - 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_domains' not in self._stubs: - self._stubs['search_domains'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/SearchDomains', - request_serializer=domains.SearchDomainsRequest.serialize, - response_deserializer=domains.SearchDomainsResponse.deserialize, - ) - return self._stubs['search_domains'] - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - domains.RetrieveRegisterParametersResponse]: - r"""Return a callable for the retrieve register parameters method over gRPC. - - Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - Returns: - Callable[[~.RetrieveRegisterParametersRequest], - ~.RetrieveRegisterParametersResponse]: - 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 'retrieve_register_parameters' not in self._stubs: - self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveRegisterParameters', - request_serializer=domains.RetrieveRegisterParametersRequest.serialize, - response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, - ) - return self._stubs['retrieve_register_parameters'] - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - operations_pb2.Operation]: - r"""Return a callable for the register domain method over gRPC. - - Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - Returns: - Callable[[~.RegisterDomainRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_domain' not in self._stubs: - self._stubs['register_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RegisterDomain', - request_serializer=domains.RegisterDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['register_domain'] - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - domains.RetrieveTransferParametersResponse]: - r"""Return a callable for the retrieve transfer parameters method over gRPC. - - Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - Returns: - Callable[[~.RetrieveTransferParametersRequest], - ~.RetrieveTransferParametersResponse]: - 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 'retrieve_transfer_parameters' not in self._stubs: - self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveTransferParameters', - request_serializer=domains.RetrieveTransferParametersRequest.serialize, - response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, - ) - return self._stubs['retrieve_transfer_parameters'] - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - operations_pb2.Operation]: - r"""Return a callable for the transfer domain method over gRPC. - - Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - Returns: - Callable[[~.TransferDomainRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'transfer_domain' not in self._stubs: - self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/TransferDomain', - request_serializer=domains.TransferDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['transfer_domain'] - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - domains.ListRegistrationsResponse]: - r"""Return a callable for the list registrations method over gRPC. - - Lists the ``Registration`` resources in a project. - - Returns: - Callable[[~.ListRegistrationsRequest], - ~.ListRegistrationsResponse]: - 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_registrations' not in self._stubs: - self._stubs['list_registrations'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ListRegistrations', - request_serializer=domains.ListRegistrationsRequest.serialize, - response_deserializer=domains.ListRegistrationsResponse.deserialize, - ) - return self._stubs['list_registrations'] - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - domains.Registration]: - r"""Return a callable for the get registration method over gRPC. - - Gets the details of a ``Registration`` resource. - - Returns: - Callable[[~.GetRegistrationRequest], - ~.Registration]: - 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_registration' not in self._stubs: - self._stubs['get_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/GetRegistration', - request_serializer=domains.GetRegistrationRequest.serialize, - response_deserializer=domains.Registration.deserialize, - ) - return self._stubs['get_registration'] - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the update registration method over gRPC. - - Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - Returns: - Callable[[~.UpdateRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_registration' not in self._stubs: - self._stubs['update_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/UpdateRegistration', - request_serializer=domains.UpdateRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_registration'] - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure management settings method over gRPC. - - Updates a ``Registration``'s management settings. - - Returns: - Callable[[~.ConfigureManagementSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_management_settings' not in self._stubs: - self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureManagementSettings', - request_serializer=domains.ConfigureManagementSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_management_settings'] - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure dns settings method over gRPC. - - Updates a ``Registration``'s DNS settings. - - Returns: - Callable[[~.ConfigureDnsSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_dns_settings' not in self._stubs: - self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureDnsSettings', - request_serializer=domains.ConfigureDnsSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_dns_settings'] - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - operations_pb2.Operation]: - r"""Return a callable for the configure contact settings method over gRPC. - - Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - Returns: - Callable[[~.ConfigureContactSettingsRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_contact_settings' not in self._stubs: - self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureContactSettings', - request_serializer=domains.ConfigureContactSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_contact_settings'] - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the export registration method over gRPC. - - Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.ExportRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'export_registration' not in self._stubs: - self._stubs['export_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ExportRegistration', - request_serializer=domains.ExportRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['export_registration'] - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete registration method over gRPC. - - Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.DeleteRegistrationRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_registration' not in self._stubs: - self._stubs['delete_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/DeleteRegistration', - request_serializer=domains.DeleteRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_registration'] - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - domains.AuthorizationCode]: - r"""Return a callable for the retrieve authorization code method over gRPC. - - Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.RetrieveAuthorizationCodeRequest], - ~.AuthorizationCode]: - 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 'retrieve_authorization_code' not in self._stubs: - self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveAuthorizationCode', - request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['retrieve_authorization_code'] - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - domains.AuthorizationCode]: - r"""Return a callable for the reset authorization code method over gRPC. - - Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.ResetAuthorizationCodeRequest], - ~.AuthorizationCode]: - 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 'reset_authorization_code' not in self._stubs: - self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ResetAuthorizationCode', - request_serializer=domains.ResetAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['reset_authorization_code'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'DomainsGrpcTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py deleted file mode 100644 index d7e3347..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/grpc_asyncio.py +++ /dev/null @@ -1,741 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.domains_v1beta1.types import domains -from google.longrunning import operations_pb2 # type: ignore -from .base import DomainsTransport, DEFAULT_CLIENT_INFO -from .grpc import DomainsGrpcTransport - - -class DomainsGrpcAsyncIOTransport(DomainsTransport): - """gRPC AsyncIO backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'domains.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsAsyncClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsAsyncClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - Awaitable[domains.SearchDomainsResponse]]: - r"""Return a callable for the search domains method over gRPC. - - Searches for available domain names similar to the provided - query. - - Availability results from this method are approximate; call - ``RetrieveRegisterParameters`` on a domain before registering to - confirm availability. - - Returns: - Callable[[~.SearchDomainsRequest], - Awaitable[~.SearchDomainsResponse]]: - 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_domains' not in self._stubs: - self._stubs['search_domains'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/SearchDomains', - request_serializer=domains.SearchDomainsRequest.serialize, - response_deserializer=domains.SearchDomainsResponse.deserialize, - ) - return self._stubs['search_domains'] - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - Awaitable[domains.RetrieveRegisterParametersResponse]]: - r"""Return a callable for the retrieve register parameters method over gRPC. - - Gets parameters needed to register a new domain name, including - price and up-to-date availability. Use the returned values to - call ``RegisterDomain``. - - Returns: - Callable[[~.RetrieveRegisterParametersRequest], - Awaitable[~.RetrieveRegisterParametersResponse]]: - 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 'retrieve_register_parameters' not in self._stubs: - self._stubs['retrieve_register_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveRegisterParameters', - request_serializer=domains.RetrieveRegisterParametersRequest.serialize, - response_deserializer=domains.RetrieveRegisterParametersResponse.deserialize, - ) - return self._stubs['retrieve_register_parameters'] - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the register domain method over gRPC. - - Registers a new domain name and creates a corresponding - ``Registration`` resource. - - Call ``RetrieveRegisterParameters`` first to check availability - of the domain name and determine parameters like price that are - needed to build a call to this method. - - A successful call creates a ``Registration`` resource in state - ``REGISTRATION_PENDING``, which resolves to ``ACTIVE`` within - 1-2 minutes, indicating that the domain was successfully - registered. If the resource ends up in state - ``REGISTRATION_FAILED``, it indicates that the domain was not - registered successfully, and you can safely delete the resource - and retry registration. - - Returns: - Callable[[~.RegisterDomainRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_domain' not in self._stubs: - self._stubs['register_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RegisterDomain', - request_serializer=domains.RegisterDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['register_domain'] - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - Awaitable[domains.RetrieveTransferParametersResponse]]: - r"""Return a callable for the retrieve transfer parameters method over gRPC. - - Gets parameters needed to transfer a domain name from another - registrar to Cloud Domains. For domains managed by Google - Domains, transferring to Cloud Domains is not supported. - - Use the returned values to call ``TransferDomain``. - - Returns: - Callable[[~.RetrieveTransferParametersRequest], - Awaitable[~.RetrieveTransferParametersResponse]]: - 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 'retrieve_transfer_parameters' not in self._stubs: - self._stubs['retrieve_transfer_parameters'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveTransferParameters', - request_serializer=domains.RetrieveTransferParametersRequest.serialize, - response_deserializer=domains.RetrieveTransferParametersResponse.deserialize, - ) - return self._stubs['retrieve_transfer_parameters'] - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the transfer domain method over gRPC. - - Transfers a domain name from another registrar to Cloud Domains. - For domains managed by Google Domains, transferring to Cloud - Domains is not supported. - - Before calling this method, go to the domain's current registrar - to unlock the domain for transfer and retrieve the domain's - transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to this - method. - - A successful call creates a ``Registration`` resource in state - ``TRANSFER_PENDING``. It can take several days to complete the - transfer process. The registrant can often speed up this process - by approving the transfer through the current registrar, either - by clicking a link in an email from the registrar or by visiting - the registrar's website. - - A few minutes after transfer approval, the resource transitions - to state ``ACTIVE``, indicating that the transfer was - successful. If the transfer is rejected or the request expires - without being approved, the resource can end up in state - ``TRANSFER_FAILED``. If transfer fails, you can safely delete - the resource and retry the transfer. - - Returns: - Callable[[~.TransferDomainRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'transfer_domain' not in self._stubs: - self._stubs['transfer_domain'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/TransferDomain', - request_serializer=domains.TransferDomainRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['transfer_domain'] - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - Awaitable[domains.ListRegistrationsResponse]]: - r"""Return a callable for the list registrations method over gRPC. - - Lists the ``Registration`` resources in a project. - - Returns: - Callable[[~.ListRegistrationsRequest], - Awaitable[~.ListRegistrationsResponse]]: - 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_registrations' not in self._stubs: - self._stubs['list_registrations'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ListRegistrations', - request_serializer=domains.ListRegistrationsRequest.serialize, - response_deserializer=domains.ListRegistrationsResponse.deserialize, - ) - return self._stubs['list_registrations'] - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - Awaitable[domains.Registration]]: - r"""Return a callable for the get registration method over gRPC. - - Gets the details of a ``Registration`` resource. - - Returns: - Callable[[~.GetRegistrationRequest], - Awaitable[~.Registration]]: - 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_registration' not in self._stubs: - self._stubs['get_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/GetRegistration', - request_serializer=domains.GetRegistrationRequest.serialize, - response_deserializer=domains.Registration.deserialize, - ) - return self._stubs['get_registration'] - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the update registration method over gRPC. - - Updates select fields of a ``Registration`` resource, notably - ``labels``. To update other fields, use the appropriate custom - update method: - - - To update management settings, see - ``ConfigureManagementSettings`` - - To update DNS configuration, see ``ConfigureDnsSettings`` - - To update contact information, see - ``ConfigureContactSettings`` - - Returns: - Callable[[~.UpdateRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_registration' not in self._stubs: - self._stubs['update_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/UpdateRegistration', - request_serializer=domains.UpdateRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_registration'] - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure management settings method over gRPC. - - Updates a ``Registration``'s management settings. - - Returns: - Callable[[~.ConfigureManagementSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_management_settings' not in self._stubs: - self._stubs['configure_management_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureManagementSettings', - request_serializer=domains.ConfigureManagementSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_management_settings'] - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure dns settings method over gRPC. - - Updates a ``Registration``'s DNS settings. - - Returns: - Callable[[~.ConfigureDnsSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_dns_settings' not in self._stubs: - self._stubs['configure_dns_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureDnsSettings', - request_serializer=domains.ConfigureDnsSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_dns_settings'] - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the configure contact settings method over gRPC. - - Updates a ``Registration``'s contact settings. Some changes - require confirmation by the domain's registrant contact . - - Returns: - Callable[[~.ConfigureContactSettingsRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'configure_contact_settings' not in self._stubs: - self._stubs['configure_contact_settings'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ConfigureContactSettings', - request_serializer=domains.ConfigureContactSettingsRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['configure_contact_settings'] - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the export registration method over gRPC. - - Exports a ``Registration`` resource, such that it is no longer - managed by Cloud Domains. - - When an active domain is successfully exported, you can continue - to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.ExportRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'export_registration' not in self._stubs: - self._stubs['export_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ExportRegistration', - request_serializer=domains.ExportRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['export_registration'] - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete registration method over gRPC. - - Deletes a ``Registration`` resource. - - This method works on any ``Registration`` resource using - `Subscription or Commitment - billing `__, provided that the - resource was created at least 1 day in the past. - - For ``Registration`` resources using `Monthly - billing `__, this method works - if: - - - ``state`` is ``EXPORTED`` with ``expire_time`` in the past - - ``state`` is ``REGISTRATION_FAILED`` - - ``state`` is ``TRANSFER_FAILED`` - - When an active registration is successfully deleted, you can - continue to use the domain in `Google - Domains `__ until it expires. The - calling user becomes the domain's sole owner in Google Domains, - and permissions for the domain are subsequently managed there. - The domain does not renew automatically unless the new owner - sets up billing in Google Domains. - - Returns: - Callable[[~.DeleteRegistrationRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_registration' not in self._stubs: - self._stubs['delete_registration'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/DeleteRegistration', - request_serializer=domains.DeleteRegistrationRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_registration'] - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - Awaitable[domains.AuthorizationCode]]: - r"""Return a callable for the retrieve authorization code method over gRPC. - - Gets the authorization code of the ``Registration`` for the - purpose of transferring the domain to another registrar. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.RetrieveAuthorizationCodeRequest], - Awaitable[~.AuthorizationCode]]: - 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 'retrieve_authorization_code' not in self._stubs: - self._stubs['retrieve_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/RetrieveAuthorizationCode', - request_serializer=domains.RetrieveAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['retrieve_authorization_code'] - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - Awaitable[domains.AuthorizationCode]]: - r"""Return a callable for the reset authorization code method over gRPC. - - Resets the authorization code of the ``Registration`` to a new - random string. - - You can call this method only after 60 days have elapsed since - the initial domain registration. - - Returns: - Callable[[~.ResetAuthorizationCodeRequest], - Awaitable[~.AuthorizationCode]]: - 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 'reset_authorization_code' not in self._stubs: - self._stubs['reset_authorization_code'] = self.grpc_channel.unary_unary( - '/google.cloud.domains.v1beta1.Domains/ResetAuthorizationCode', - request_serializer=domains.ResetAuthorizationCodeRequest.serialize, - response_deserializer=domains.AuthorizationCode.deserialize, - ) - return self._stubs['reset_authorization_code'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'DomainsGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py deleted file mode 100644 index 1d1db6e..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/services/domains/transports/rest.py +++ /dev/null @@ -1,1976 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from google.api_core import operations_v1 -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - - -from google.cloud.domains_v1beta1.types import domains -from google.longrunning import operations_pb2 # type: ignore - -from .base import DomainsTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class DomainsRestInterceptor: - """Interceptor for Domains. - - 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 DomainsRestTransport. - - .. code-block:: python - class MyCustomDomainsInterceptor(DomainsRestInterceptor): - def pre_configure_contact_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_contact_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_configure_dns_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_dns_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_configure_management_settings(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_configure_management_settings(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_delete_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_export_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_export_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_registration(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_registrations(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_registrations(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_domain(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_domain(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_reset_authorization_code(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_reset_authorization_code(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_authorization_code(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_authorization_code(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_register_parameters(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_register_parameters(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_retrieve_transfer_parameters(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_retrieve_transfer_parameters(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_search_domains(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_search_domains(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_transfer_domain(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_transfer_domain(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_registration(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_registration(self, response): - logging.log(f"Received response: {response}") - return response - - transport = DomainsRestTransport(interceptor=MyCustomDomainsInterceptor()) - client = DomainsClient(transport=transport) - - - """ - def pre_configure_contact_settings(self, request: domains.ConfigureContactSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureContactSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_contact_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_contact_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_contact_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_configure_dns_settings(self, request: domains.ConfigureDnsSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureDnsSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_dns_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_dns_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_dns_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_configure_management_settings(self, request: domains.ConfigureManagementSettingsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ConfigureManagementSettingsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for configure_management_settings - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_configure_management_settings(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for configure_management_settings - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_delete_registration(self, request: domains.DeleteRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.DeleteRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_delete_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for delete_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_export_registration(self, request: domains.ExportRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ExportRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for export_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_export_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for export_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_get_registration(self, request: domains.GetRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.GetRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_get_registration(self, response: domains.Registration) -> domains.Registration: - """Post-rpc interceptor for get_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_list_registrations(self, request: domains.ListRegistrationsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ListRegistrationsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_registrations - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_list_registrations(self, response: domains.ListRegistrationsResponse) -> domains.ListRegistrationsResponse: - """Post-rpc interceptor for list_registrations - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_register_domain(self, request: domains.RegisterDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RegisterDomainRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_domain - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_register_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for register_domain - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_reset_authorization_code(self, request: domains.ResetAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.ResetAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for reset_authorization_code - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_reset_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: - """Post-rpc interceptor for reset_authorization_code - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_authorization_code(self, request: domains.RetrieveAuthorizationCodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveAuthorizationCodeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_authorization_code - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_authorization_code(self, response: domains.AuthorizationCode) -> domains.AuthorizationCode: - """Post-rpc interceptor for retrieve_authorization_code - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_register_parameters(self, request: domains.RetrieveRegisterParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveRegisterParametersRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_register_parameters - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_register_parameters(self, response: domains.RetrieveRegisterParametersResponse) -> domains.RetrieveRegisterParametersResponse: - """Post-rpc interceptor for retrieve_register_parameters - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_retrieve_transfer_parameters(self, request: domains.RetrieveTransferParametersRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.RetrieveTransferParametersRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for retrieve_transfer_parameters - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_retrieve_transfer_parameters(self, response: domains.RetrieveTransferParametersResponse) -> domains.RetrieveTransferParametersResponse: - """Post-rpc interceptor for retrieve_transfer_parameters - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_search_domains(self, request: domains.SearchDomainsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.SearchDomainsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for search_domains - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_search_domains(self, response: domains.SearchDomainsResponse) -> domains.SearchDomainsResponse: - """Post-rpc interceptor for search_domains - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_transfer_domain(self, request: domains.TransferDomainRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.TransferDomainRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for transfer_domain - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_transfer_domain(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for transfer_domain - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - def pre_update_registration(self, request: domains.UpdateRegistrationRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[domains.UpdateRegistrationRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_registration - - Override in a subclass to manipulate the request or metadata - before they are sent to the Domains server. - """ - return request, metadata - - def post_update_registration(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for update_registration - - Override in a subclass to manipulate the response - after it is returned by the Domains server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class DomainsRestStub: - _session: AuthorizedSession - _host: str - _interceptor: DomainsRestInterceptor - - -class DomainsRestTransport(DomainsTransport): - """REST backend transport for Domains. - - The Cloud Domains API enables management and configuration of - domain names. - - 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 = 'domains.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[DomainsRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or DomainsRestInterceptor() - self._prep_wrapped_messages(client_info) - - @property - def operations_client(self) -> operations_v1.AbstractOperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Only create a new client if we do not already have one. - if self._operations_client is None: - http_options: Dict[str, List[Dict[str, str]]] = { - 'google.longrunning.Operations.GetOperation': [ - { - 'method': 'get', - 'uri': '/v1beta1/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.ListOperations': [ - { - 'method': 'get', - 'uri': '/v1beta1/{name=projects/*/locations/*}/operations', - }, - ], - } - - rest_transport = operations_v1.OperationsRestTransport( - host=self._host, - # use the credentials which are saved - credentials=self._credentials, - scopes=self._scopes, - http_options=http_options, - path_prefix="v1beta1") - - self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) - - # Return the client from cache. - return self._operations_client - - class _ConfigureContactSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureContactSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureContactSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure contact - settings method over HTTP. - - Args: - request (~.domains.ConfigureContactSettingsRequest): - The request object. Request for the ``ConfigureContactSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_contact_settings(request, metadata) - pb_request = domains.ConfigureContactSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_contact_settings(resp) - return resp - - class _ConfigureDnsSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureDnsSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureDnsSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure dns settings method over HTTP. - - Args: - request (~.domains.ConfigureDnsSettingsRequest): - The request object. Request for the ``ConfigureDnsSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_dns_settings(request, metadata) - pb_request = domains.ConfigureDnsSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_dns_settings(resp) - return resp - - class _ConfigureManagementSettings(DomainsRestStub): - def __hash__(self): - return hash("ConfigureManagementSettings") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ConfigureManagementSettingsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the configure management - settings method over HTTP. - - Args: - request (~.domains.ConfigureManagementSettingsRequest): - The request object. Request for the ``ConfigureManagementSettings`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_configure_management_settings(request, metadata) - pb_request = domains.ConfigureManagementSettingsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_configure_management_settings(resp) - return resp - - class _DeleteRegistration(DomainsRestStub): - def __hash__(self): - return hash("DeleteRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.DeleteRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the delete registration method over HTTP. - - Args: - request (~.domains.DeleteRegistrationRequest): - The request object. Request for the ``DeleteRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_registration(request, metadata) - pb_request = domains.DeleteRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_delete_registration(resp) - return resp - - class _ExportRegistration(DomainsRestStub): - def __hash__(self): - return hash("ExportRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ExportRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the export registration method over HTTP. - - Args: - request (~.domains.ExportRegistrationRequest): - The request object. Request for the ``ExportRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}:export', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_export_registration(request, metadata) - pb_request = domains.ExportRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_export_registration(resp) - return resp - - class _GetRegistration(DomainsRestStub): - def __hash__(self): - return hash("GetRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.GetRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.Registration: - r"""Call the get registration method over HTTP. - - Args: - request (~.domains.GetRegistrationRequest): - The request object. Request for the ``GetRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.Registration: - The ``Registration`` resource facilitates managing and - configuring domain name registrations. - - There are several ways to create a new ``Registration`` - resource: - - To create a new ``Registration`` resource, find a - suitable domain name by calling the ``SearchDomains`` - method with a query to see available domain name - options. After choosing a name, call - ``RetrieveRegisterParameters`` to ensure availability - and obtain information like pricing, which is needed to - build a call to ``RegisterDomain``. - - Another way to create a new ``Registration`` is to - transfer an existing domain from another registrar. - First, go to the current registrar to unlock the domain - for transfer and retrieve the domain's transfer - authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the - domain is unlocked and to get values needed to build a - call to ``TransferDomain``. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{name=projects/*/locations/*/registrations/*}', - }, - ] - request, metadata = self._interceptor.pre_get_registration(request, metadata) - pb_request = domains.GetRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.Registration() - pb_resp = domains.Registration.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_registration(resp) - return resp - - class _ListRegistrations(DomainsRestStub): - def __hash__(self): - return hash("ListRegistrations") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ListRegistrationsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.ListRegistrationsResponse: - r"""Call the list registrations method over HTTP. - - Args: - request (~.domains.ListRegistrationsRequest): - The request object. Request for the ``ListRegistrations`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.ListRegistrationsResponse: - Response for the ``ListRegistrations`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations', - }, - ] - request, metadata = self._interceptor.pre_list_registrations(request, metadata) - pb_request = domains.ListRegistrationsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.ListRegistrationsResponse() - pb_resp = domains.ListRegistrationsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_registrations(resp) - return resp - - class _RegisterDomain(DomainsRestStub): - def __hash__(self): - return hash("RegisterDomain") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RegisterDomainRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the register domain method over HTTP. - - Args: - request (~.domains.RegisterDomainRequest): - The request object. Request for the ``RegisterDomain`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations:register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_domain(request, metadata) - pb_request = domains.RegisterDomainRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_domain(resp) - return resp - - class _ResetAuthorizationCode(DomainsRestStub): - def __hash__(self): - return hash("ResetAuthorizationCode") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.ResetAuthorizationCodeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.AuthorizationCode: - r"""Call the reset authorization code method over HTTP. - - Args: - request (~.domains.ResetAuthorizationCodeRequest): - The request object. Request for the ``ResetAuthorizationCode`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.AuthorizationCode: - Defines an authorization code. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_reset_authorization_code(request, metadata) - pb_request = domains.ResetAuthorizationCodeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.AuthorizationCode() - pb_resp = domains.AuthorizationCode.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_reset_authorization_code(resp) - return resp - - class _RetrieveAuthorizationCode(DomainsRestStub): - def __hash__(self): - return hash("RetrieveAuthorizationCode") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveAuthorizationCodeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.AuthorizationCode: - r"""Call the retrieve authorization - code method over HTTP. - - Args: - request (~.domains.RetrieveAuthorizationCodeRequest): - The request object. Request for the ``RetrieveAuthorizationCode`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.AuthorizationCode: - Defines an authorization code. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode', - }, - ] - request, metadata = self._interceptor.pre_retrieve_authorization_code(request, metadata) - pb_request = domains.RetrieveAuthorizationCodeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.AuthorizationCode() - pb_resp = domains.AuthorizationCode.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_authorization_code(resp) - return resp - - class _RetrieveRegisterParameters(DomainsRestStub): - def __hash__(self): - return hash("RetrieveRegisterParameters") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "domainName" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveRegisterParametersRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.RetrieveRegisterParametersResponse: - r"""Call the retrieve register - parameters method over HTTP. - - Args: - request (~.domains.RetrieveRegisterParametersRequest): - The request object. Request for the ``RetrieveRegisterParameters`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.RetrieveRegisterParametersResponse: - Response for the ``RetrieveRegisterParameters`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters', - }, - ] - request, metadata = self._interceptor.pre_retrieve_register_parameters(request, metadata) - pb_request = domains.RetrieveRegisterParametersRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.RetrieveRegisterParametersResponse() - pb_resp = domains.RetrieveRegisterParametersResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_register_parameters(resp) - return resp - - class _RetrieveTransferParameters(DomainsRestStub): - def __hash__(self): - return hash("RetrieveTransferParameters") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "domainName" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.RetrieveTransferParametersRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.RetrieveTransferParametersResponse: - r"""Call the retrieve transfer - parameters method over HTTP. - - Args: - request (~.domains.RetrieveTransferParametersRequest): - The request object. Request for the ``RetrieveTransferParameters`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.RetrieveTransferParametersResponse: - Response for the ``RetrieveTransferParameters`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters', - }, - ] - request, metadata = self._interceptor.pre_retrieve_transfer_parameters(request, metadata) - pb_request = domains.RetrieveTransferParametersRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.RetrieveTransferParametersResponse() - pb_resp = domains.RetrieveTransferParametersResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_retrieve_transfer_parameters(resp) - return resp - - class _SearchDomains(DomainsRestStub): - def __hash__(self): - return hash("SearchDomains") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "query" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.SearchDomainsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> domains.SearchDomainsResponse: - r"""Call the search domains method over HTTP. - - Args: - request (~.domains.SearchDomainsRequest): - The request object. Request for the ``SearchDomains`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.domains.SearchDomainsResponse: - Response for the ``SearchDomains`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1beta1/{location=projects/*/locations/*}/registrations:searchDomains', - }, - ] - request, metadata = self._interceptor.pre_search_domains(request, metadata) - pb_request = domains.SearchDomainsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = domains.SearchDomainsResponse() - pb_resp = domains.SearchDomainsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_search_domains(resp) - return resp - - class _TransferDomain(DomainsRestStub): - def __hash__(self): - return hash("TransferDomain") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.TransferDomainRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the transfer domain method over HTTP. - - Args: - request (~.domains.TransferDomainRequest): - The request object. Request for the ``TransferDomain`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1beta1/{parent=projects/*/locations/*}/registrations:transfer', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_transfer_domain(request, metadata) - pb_request = domains.TransferDomainRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_transfer_domain(resp) - return resp - - class _UpdateRegistration(DomainsRestStub): - def __hash__(self): - return hash("UpdateRegistration") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "updateMask" : {}, } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: domains.UpdateRegistrationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the update registration method over HTTP. - - Args: - request (~.domains.UpdateRegistrationRequest): - The request object. Request for the ``UpdateRegistration`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1beta1/{registration.name=projects/*/locations/*/registrations/*}', - 'body': 'registration', - }, - ] - request, metadata = self._interceptor.pre_update_registration(request, metadata) - pb_request = domains.UpdateRegistrationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_registration(resp) - return resp - - @property - def configure_contact_settings(self) -> Callable[ - [domains.ConfigureContactSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureContactSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def configure_dns_settings(self) -> Callable[ - [domains.ConfigureDnsSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureDnsSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def configure_management_settings(self) -> Callable[ - [domains.ConfigureManagementSettingsRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ConfigureManagementSettings(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_registration(self) -> Callable[ - [domains.DeleteRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def export_registration(self) -> Callable[ - [domains.ExportRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ExportRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_registration(self) -> Callable[ - [domains.GetRegistrationRequest], - domains.Registration]: - # 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._GetRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_registrations(self) -> Callable[ - [domains.ListRegistrationsRequest], - domains.ListRegistrationsResponse]: - # 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._ListRegistrations(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_domain(self) -> Callable[ - [domains.RegisterDomainRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDomain(self._session, self._host, self._interceptor) # type: ignore - - @property - def reset_authorization_code(self) -> Callable[ - [domains.ResetAuthorizationCodeRequest], - domains.AuthorizationCode]: - # 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._ResetAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_authorization_code(self) -> Callable[ - [domains.RetrieveAuthorizationCodeRequest], - domains.AuthorizationCode]: - # 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._RetrieveAuthorizationCode(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_register_parameters(self) -> Callable[ - [domains.RetrieveRegisterParametersRequest], - domains.RetrieveRegisterParametersResponse]: - # 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._RetrieveRegisterParameters(self._session, self._host, self._interceptor) # type: ignore - - @property - def retrieve_transfer_parameters(self) -> Callable[ - [domains.RetrieveTransferParametersRequest], - domains.RetrieveTransferParametersResponse]: - # 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._RetrieveTransferParameters(self._session, self._host, self._interceptor) # type: ignore - - @property - def search_domains(self) -> Callable[ - [domains.SearchDomainsRequest], - domains.SearchDomainsResponse]: - # 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._SearchDomains(self._session, self._host, self._interceptor) # type: ignore - - @property - def transfer_domain(self) -> Callable[ - [domains.TransferDomainRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._TransferDomain(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_registration(self) -> Callable[ - [domains.UpdateRegistrationRequest], - operations_pb2.Operation]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateRegistration(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'DomainsRestTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py deleted file mode 100644 index cb45e82..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/__init__.py +++ /dev/null @@ -1,82 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .domains import ( - AuthorizationCode, - ConfigureContactSettingsRequest, - ConfigureDnsSettingsRequest, - ConfigureManagementSettingsRequest, - ContactSettings, - DeleteRegistrationRequest, - DnsSettings, - ExportRegistrationRequest, - GetRegistrationRequest, - ListRegistrationsRequest, - ListRegistrationsResponse, - ManagementSettings, - OperationMetadata, - RegisterDomainRequest, - RegisterParameters, - Registration, - ResetAuthorizationCodeRequest, - RetrieveAuthorizationCodeRequest, - RetrieveRegisterParametersRequest, - RetrieveRegisterParametersResponse, - RetrieveTransferParametersRequest, - RetrieveTransferParametersResponse, - SearchDomainsRequest, - SearchDomainsResponse, - TransferDomainRequest, - TransferParameters, - UpdateRegistrationRequest, - ContactNotice, - ContactPrivacy, - DomainNotice, - TransferLockState, -) - -__all__ = ( - 'AuthorizationCode', - 'ConfigureContactSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureManagementSettingsRequest', - 'ContactSettings', - 'DeleteRegistrationRequest', - 'DnsSettings', - 'ExportRegistrationRequest', - 'GetRegistrationRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'ManagementSettings', - 'OperationMetadata', - 'RegisterDomainRequest', - 'RegisterParameters', - 'Registration', - 'ResetAuthorizationCodeRequest', - 'RetrieveAuthorizationCodeRequest', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'TransferDomainRequest', - 'TransferParameters', - 'UpdateRegistrationRequest', - 'ContactNotice', - 'ContactPrivacy', - 'DomainNotice', - 'TransferLockState', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py b/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py deleted file mode 100644 index 282503d..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/domains_v1beta1/types/domains.py +++ /dev/null @@ -1,1523 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from google.type import postal_address_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.domains.v1beta1', - manifest={ - 'ContactPrivacy', - 'DomainNotice', - 'ContactNotice', - 'TransferLockState', - 'Registration', - 'ManagementSettings', - 'DnsSettings', - 'ContactSettings', - 'SearchDomainsRequest', - 'SearchDomainsResponse', - 'RetrieveRegisterParametersRequest', - 'RetrieveRegisterParametersResponse', - 'RegisterDomainRequest', - 'RetrieveTransferParametersRequest', - 'RetrieveTransferParametersResponse', - 'TransferDomainRequest', - 'ListRegistrationsRequest', - 'ListRegistrationsResponse', - 'GetRegistrationRequest', - 'UpdateRegistrationRequest', - 'ConfigureManagementSettingsRequest', - 'ConfigureDnsSettingsRequest', - 'ConfigureContactSettingsRequest', - 'ExportRegistrationRequest', - 'DeleteRegistrationRequest', - 'RetrieveAuthorizationCodeRequest', - 'ResetAuthorizationCodeRequest', - 'RegisterParameters', - 'TransferParameters', - 'AuthorizationCode', - 'OperationMetadata', - }, -) - - -class ContactPrivacy(proto.Enum): - r"""Defines a set of possible contact privacy settings for a - ``Registration``. - - `ICANN `__ maintains the WHOIS database, a - publicly accessible mapping from domain name to contact information, - and requires that each domain name have an entry. Choose from these - options to control how much information in your ``ContactSettings`` - is published. - - Values: - CONTACT_PRIVACY_UNSPECIFIED (0): - The contact privacy settings are undefined. - PUBLIC_CONTACT_DATA (1): - All the data from ``ContactSettings`` is publicly available. - When setting this option, you must also provide a - ``PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT`` in the - ``contact_notices`` field of the request. - PRIVATE_CONTACT_DATA (2): - None of the data from ``ContactSettings`` is publicly - available. Instead, proxy contact data is published for your - domain. Email sent to the proxy email address is forwarded - to the registrant's email address. Cloud Domains provides - this privacy proxy service at no additional cost. - REDACTED_CONTACT_DATA (3): - Some data from ``ContactSettings`` is publicly available. - The actual information redacted depends on the domain. For - details, see `the registration privacy - article `__. - """ - CONTACT_PRIVACY_UNSPECIFIED = 0 - PUBLIC_CONTACT_DATA = 1 - PRIVATE_CONTACT_DATA = 2 - REDACTED_CONTACT_DATA = 3 - - -class DomainNotice(proto.Enum): - r"""Notices about special properties of certain domains. - - Values: - DOMAIN_NOTICE_UNSPECIFIED (0): - The notice is undefined. - HSTS_PRELOADED (1): - Indicates that the domain is preloaded on the HTTP Strict - Transport Security list in browsers. Serving a website on - such domain requires an SSL certificate. For details, see - `how to get an SSL - certificate `__. - """ - DOMAIN_NOTICE_UNSPECIFIED = 0 - HSTS_PRELOADED = 1 - - -class ContactNotice(proto.Enum): - r"""Notices related to contact information. - - Values: - CONTACT_NOTICE_UNSPECIFIED (0): - The notice is undefined. - PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1): - Required when setting the ``privacy`` field of - ``ContactSettings`` to ``PUBLIC_CONTACT_DATA``, which - exposes contact data publicly. - """ - CONTACT_NOTICE_UNSPECIFIED = 0 - PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT = 1 - - -class TransferLockState(proto.Enum): - r"""Possible states of a ``Registration``'s transfer lock. - - Values: - TRANSFER_LOCK_STATE_UNSPECIFIED (0): - The state is unspecified. - UNLOCKED (1): - The domain is unlocked and can be transferred - to another registrar. - LOCKED (2): - The domain is locked and cannot be - transferred to another registrar. - """ - TRANSFER_LOCK_STATE_UNSPECIFIED = 0 - UNLOCKED = 1 - LOCKED = 2 - - -class Registration(proto.Message): - r"""The ``Registration`` resource facilitates managing and configuring - domain name registrations. - - There are several ways to create a new ``Registration`` resource: - - To create a new ``Registration`` resource, find a suitable domain - name by calling the ``SearchDomains`` method with a query to see - available domain name options. After choosing a name, call - ``RetrieveRegisterParameters`` to ensure availability and obtain - information like pricing, which is needed to build a call to - ``RegisterDomain``. - - Another way to create a new ``Registration`` is to transfer an - existing domain from another registrar. First, go to the current - registrar to unlock the domain for transfer and retrieve the - domain's transfer authorization code. Then call - ``RetrieveTransferParameters`` to confirm that the domain is - unlocked and to get values needed to build a call to - ``TransferDomain``. - - Attributes: - name (str): - Output only. Name of the ``Registration`` resource, in the - format - ``projects/*/locations/*/registrations/``. - domain_name (str): - Required. Immutable. The domain name. Unicode - domain names must be expressed in Punycode - format. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The creation timestamp of the ``Registration`` - resource. - expire_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The expiration timestamp of the - ``Registration``. - state (google.cloud.domains_v1beta1.types.Registration.State): - Output only. The state of the ``Registration`` - issues (MutableSequence[google.cloud.domains_v1beta1.types.Registration.Issue]): - Output only. The set of issues with the ``Registration`` - that require attention. - labels (MutableMapping[str, str]): - Set of labels associated with the ``Registration``. - management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): - Settings for management of the ``Registration``, including - renewal, billing, and transfer. You cannot update these with - the ``UpdateRegistration`` method. To update these settings, - use the ``ConfigureManagementSettings`` method. - dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): - Settings controlling the DNS configuration of the - ``Registration``. You cannot update these with the - ``UpdateRegistration`` method. To update these settings, use - the ``ConfigureDnsSettings`` method. - contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): - Required. Settings for contact information linked to the - ``Registration``. You cannot update these with the - ``UpdateRegistration`` method. To update these settings, use - the ``ConfigureContactSettings`` method. - pending_contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): - Output only. Pending contact settings for the - ``Registration``. Updates to the ``contact_settings`` field - that change its ``registrant_contact`` or ``privacy`` fields - require email confirmation by the ``registrant_contact`` - before taking effect. This field is set only if there are - pending updates to the ``contact_settings`` that have not - been confirmed. To confirm the changes, the - ``registrant_contact`` must follow the instructions in the - email they receive. - supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): - Output only. Set of options for the - ``contact_settings.privacy`` field that this - ``Registration`` supports. - """ - class State(proto.Enum): - r"""Possible states of a ``Registration``. - - Values: - STATE_UNSPECIFIED (0): - The state is undefined. - REGISTRATION_PENDING (1): - The domain is being registered. - REGISTRATION_FAILED (2): - The domain registration failed. You can - delete resources in this state to allow - registration to be retried. - TRANSFER_PENDING (3): - The domain is being transferred from another - registrar to Cloud Domains. - TRANSFER_FAILED (4): - The attempt to transfer the domain from - another registrar to Cloud Domains failed. You - can delete resources in this state and retry the - transfer. - ACTIVE (6): - The domain is registered and operational. The - domain renews automatically as long as it - remains in this state. - SUSPENDED (7): - The domain is suspended and inoperative. For more details, - see the ``issues`` field. - EXPORTED (8): - The domain is no longer managed with Cloud Domains. It may - have been transferred to another registrar or exported for - management in `Google Domains `__. - You can no longer update it with this API, and information - shown about it may be stale. Domains in this state are not - automatically renewed by Cloud Domains. - """ - STATE_UNSPECIFIED = 0 - REGISTRATION_PENDING = 1 - REGISTRATION_FAILED = 2 - TRANSFER_PENDING = 3 - TRANSFER_FAILED = 4 - ACTIVE = 6 - SUSPENDED = 7 - EXPORTED = 8 - - class Issue(proto.Enum): - r"""Possible issues with a ``Registration`` that require attention. - - Values: - ISSUE_UNSPECIFIED (0): - The issue is undefined. - CONTACT_SUPPORT (1): - Contact the Cloud Support team to resolve a - problem with this domain. - UNVERIFIED_EMAIL (2): - `ICANN `__ requires verification of the - email address in the ``Registration``'s - ``contact_settings.registrant_contact`` field. To verify the - email address, follow the instructions in the email the - ``registrant_contact`` receives following registration. If - you do not complete email verification within 15 days of - registration, the domain is suspended. To resend the - verification email, call ConfigureContactSettings and - provide the current ``registrant_contact.email``. - """ - ISSUE_UNSPECIFIED = 0 - CONTACT_SUPPORT = 1 - UNVERIFIED_EMAIL = 2 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - domain_name: str = proto.Field( - proto.STRING, - number=2, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - expire_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=6, - message=timestamp_pb2.Timestamp, - ) - state: State = proto.Field( - proto.ENUM, - number=7, - enum=State, - ) - issues: MutableSequence[Issue] = proto.RepeatedField( - proto.ENUM, - number=8, - enum=Issue, - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=9, - ) - management_settings: 'ManagementSettings' = proto.Field( - proto.MESSAGE, - number=10, - message='ManagementSettings', - ) - dns_settings: 'DnsSettings' = proto.Field( - proto.MESSAGE, - number=11, - message='DnsSettings', - ) - contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=12, - message='ContactSettings', - ) - pending_contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=13, - message='ContactSettings', - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=14, - enum='ContactPrivacy', - ) - - -class ManagementSettings(proto.Message): - r"""Defines renewal, billing, and transfer settings for a - ``Registration``. - - Attributes: - renewal_method (google.cloud.domains_v1beta1.types.ManagementSettings.RenewalMethod): - Output only. The renewal method for this ``Registration``. - transfer_lock_state (google.cloud.domains_v1beta1.types.TransferLockState): - Controls whether the domain can be - transferred to another registrar. - """ - class RenewalMethod(proto.Enum): - r"""Defines how the ``Registration`` is renewed. - - Values: - RENEWAL_METHOD_UNSPECIFIED (0): - The renewal method is undefined. - AUTOMATIC_RENEWAL (1): - The domain is automatically renewed each year . - - To disable automatic renewals, delete the resource by - calling ``DeleteRegistration`` or export it by calling - ``ExportRegistration``. - MANUAL_RENEWAL (2): - The domain must be explicitly renewed each year before its - ``expire_time``. This option is only available when the - ``Registration`` is in state ``EXPORTED``. - - To manage the domain's current billing and renewal settings, - go to `Google Domains `__. - """ - RENEWAL_METHOD_UNSPECIFIED = 0 - AUTOMATIC_RENEWAL = 1 - MANUAL_RENEWAL = 2 - - renewal_method: RenewalMethod = proto.Field( - proto.ENUM, - number=3, - enum=RenewalMethod, - ) - transfer_lock_state: 'TransferLockState' = proto.Field( - proto.ENUM, - number=4, - enum='TransferLockState', - ) - - -class DnsSettings(proto.Message): - r"""Defines the DNS configuration of a ``Registration``, including name - servers, DNSSEC, and glue records. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - custom_dns (google.cloud.domains_v1beta1.types.DnsSettings.CustomDns): - An arbitrary DNS provider identified by its - name servers. - - This field is a member of `oneof`_ ``dns_provider``. - google_domains_dns (google.cloud.domains_v1beta1.types.DnsSettings.GoogleDomainsDns): - The free DNS zone provided by `Google - Domains `__. - - This field is a member of `oneof`_ ``dns_provider``. - glue_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.GlueRecord]): - The list of glue records for this ``Registration``. Commonly - empty. - """ - class DsState(proto.Enum): - r"""The publication state of DS records for a ``Registration``. - - Values: - DS_STATE_UNSPECIFIED (0): - DS state is unspecified. - DS_RECORDS_UNPUBLISHED (1): - DNSSEC is disabled for this domain. No DS - records for this domain are published in the - parent DNS zone. - DS_RECORDS_PUBLISHED (2): - DNSSEC is enabled for this domain. Appropriate DS records - for this domain are published in the parent DNS zone. This - option is valid only if the DNS zone referenced in the - ``Registration``'s ``dns_provider`` field is already - DNSSEC-signed. - """ - DS_STATE_UNSPECIFIED = 0 - DS_RECORDS_UNPUBLISHED = 1 - DS_RECORDS_PUBLISHED = 2 - - class CustomDns(proto.Message): - r"""Configuration for an arbitrary DNS provider. - - Attributes: - name_servers (MutableSequence[str]): - Required. A list of name servers that store - the DNS zone for this domain. Each name server - is a domain name, with Unicode domain names - expressed in Punycode format. - ds_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.DsRecord]): - The list of DS records for this domain, which - are used to enable DNSSEC. The domain's DNS - provider can provide the values to set here. If - this field is empty, DNSSEC is disabled. - """ - - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='DnsSettings.DsRecord', - ) - - class GoogleDomainsDns(proto.Message): - r"""Configuration for using the free DNS zone provided by Google Domains - as a ``Registration``'s ``dns_provider``. You cannot configure the - DNS zone itself using the API. To configure the DNS zone, go to - `Google Domains `__. - - Attributes: - name_servers (MutableSequence[str]): - Output only. A list of name servers that - store the DNS zone for this domain. Each name - server is a domain name, with Unicode domain - names expressed in Punycode format. This field - is automatically populated with the name servers - assigned to the Google Domains DNS zone. - ds_state (google.cloud.domains_v1beta1.types.DnsSettings.DsState): - Required. The state of DS records for this - domain. Used to enable or disable automatic - DNSSEC. - ds_records (MutableSequence[google.cloud.domains_v1beta1.types.DnsSettings.DsRecord]): - Output only. The list of DS records published for this - domain. The list is automatically populated when - ``ds_state`` is ``DS_RECORDS_PUBLISHED``, otherwise it - remains empty. - """ - - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - ds_state: 'DnsSettings.DsState' = proto.Field( - proto.ENUM, - number=2, - enum='DnsSettings.DsState', - ) - ds_records: MutableSequence['DnsSettings.DsRecord'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='DnsSettings.DsRecord', - ) - - class DsRecord(proto.Message): - r"""Defines a Delegation Signer (DS) record, which is needed to - enable DNSSEC for a domain. It contains a digest (hash) of a - DNSKEY record that must be present in the domain's DNS zone. - - Attributes: - key_tag (int): - The key tag of the record. Must be set in - range 0 -- 65535. - algorithm (google.cloud.domains_v1beta1.types.DnsSettings.DsRecord.Algorithm): - The algorithm used to generate the referenced - DNSKEY. - digest_type (google.cloud.domains_v1beta1.types.DnsSettings.DsRecord.DigestType): - The hash function used to generate the digest - of the referenced DNSKEY. - digest (str): - The digest generated from the referenced - DNSKEY. - """ - class Algorithm(proto.Enum): - r"""List of algorithms used to create a DNSKEY. Certain - algorithms are not supported for particular domains. - - Values: - ALGORITHM_UNSPECIFIED (0): - The algorithm is unspecified. - RSAMD5 (1): - RSA/MD5. Cannot be used for new deployments. - DH (2): - Diffie-Hellman. Cannot be used for new - deployments. - DSA (3): - DSA/SHA1. Not recommended for new - deployments. - ECC (4): - ECC. Not recommended for new deployments. - RSASHA1 (5): - RSA/SHA-1. Not recommended for new - deployments. - DSANSEC3SHA1 (6): - DSA-NSEC3-SHA1. Not recommended for new - deployments. - RSASHA1NSEC3SHA1 (7): - RSA/SHA1-NSEC3-SHA1. Not recommended for new - deployments. - RSASHA256 (8): - RSA/SHA-256. - RSASHA512 (10): - RSA/SHA-512. - ECCGOST (12): - GOST R 34.10-2001. - ECDSAP256SHA256 (13): - ECDSA Curve P-256 with SHA-256. - ECDSAP384SHA384 (14): - ECDSA Curve P-384 with SHA-384. - ED25519 (15): - Ed25519. - ED448 (16): - Ed448. - INDIRECT (252): - Reserved for Indirect Keys. Cannot be used - for new deployments. - PRIVATEDNS (253): - Private algorithm. Cannot be used for new - deployments. - PRIVATEOID (254): - Private algorithm OID. Cannot be used for new - deployments. - """ - ALGORITHM_UNSPECIFIED = 0 - RSAMD5 = 1 - DH = 2 - DSA = 3 - ECC = 4 - RSASHA1 = 5 - DSANSEC3SHA1 = 6 - RSASHA1NSEC3SHA1 = 7 - RSASHA256 = 8 - RSASHA512 = 10 - ECCGOST = 12 - ECDSAP256SHA256 = 13 - ECDSAP384SHA384 = 14 - ED25519 = 15 - ED448 = 16 - INDIRECT = 252 - PRIVATEDNS = 253 - PRIVATEOID = 254 - - class DigestType(proto.Enum): - r"""List of hash functions that may have been used to generate a - digest of a DNSKEY. - - Values: - DIGEST_TYPE_UNSPECIFIED (0): - The DigestType is unspecified. - SHA1 (1): - SHA-1. Not recommended for new deployments. - SHA256 (2): - SHA-256. - GOST3411 (3): - GOST R 34.11-94. - SHA384 (4): - SHA-384. - """ - DIGEST_TYPE_UNSPECIFIED = 0 - SHA1 = 1 - SHA256 = 2 - GOST3411 = 3 - SHA384 = 4 - - key_tag: int = proto.Field( - proto.INT32, - number=1, - ) - algorithm: 'DnsSettings.DsRecord.Algorithm' = proto.Field( - proto.ENUM, - number=2, - enum='DnsSettings.DsRecord.Algorithm', - ) - digest_type: 'DnsSettings.DsRecord.DigestType' = proto.Field( - proto.ENUM, - number=3, - enum='DnsSettings.DsRecord.DigestType', - ) - digest: str = proto.Field( - proto.STRING, - number=4, - ) - - class GlueRecord(proto.Message): - r"""Defines a host on your domain that is a DNS name server for your - domain and/or other domains. Glue records are a way of making the IP - address of a name server known, even when it serves DNS queries for - its parent domain. For example, when ``ns.example.com`` is a name - server for ``example.com``, the host ``ns.example.com`` must have a - glue record to break the circular DNS reference. - - Attributes: - host_name (str): - Required. Domain name of the host in Punycode - format. - ipv4_addresses (MutableSequence[str]): - List of IPv4 addresses corresponding to this host in the - standard decimal format (e.g. ``198.51.100.1``). At least - one of ``ipv4_address`` and ``ipv6_address`` must be set. - ipv6_addresses (MutableSequence[str]): - List of IPv6 addresses corresponding to this host in the - standard hexadecimal format (e.g. ``2001:db8::``). At least - one of ``ipv4_address`` and ``ipv6_address`` must be set. - """ - - host_name: str = proto.Field( - proto.STRING, - number=1, - ) - ipv4_addresses: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=2, - ) - ipv6_addresses: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - - custom_dns: CustomDns = proto.Field( - proto.MESSAGE, - number=1, - oneof='dns_provider', - message=CustomDns, - ) - google_domains_dns: GoogleDomainsDns = proto.Field( - proto.MESSAGE, - number=2, - oneof='dns_provider', - message=GoogleDomainsDns, - ) - glue_records: MutableSequence[GlueRecord] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message=GlueRecord, - ) - - -class ContactSettings(proto.Message): - r"""Defines the contact information associated with a ``Registration``. - - `ICANN `__ requires all domain names to have - associated contact information. The ``registrant_contact`` is - considered the domain's legal owner, and often the other contacts - are identical. - - Attributes: - privacy (google.cloud.domains_v1beta1.types.ContactPrivacy): - Required. Privacy setting for the contacts associated with - the ``Registration``. - registrant_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): - Required. The registrant contact for the ``Registration``. - - *Caution: Anyone with access to this email address, phone - number, and/or postal address can take control of the - domain.* - - *Warning: For new ``Registration``\ s, the registrant - receives an email confirmation that they must complete - within 15 days to avoid domain suspension.* - admin_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): - Required. The administrative contact for the - ``Registration``. - technical_contact (google.cloud.domains_v1beta1.types.ContactSettings.Contact): - Required. The technical contact for the ``Registration``. - """ - - class Contact(proto.Message): - r"""Details required for a contact associated with a ``Registration``. - - Attributes: - postal_address (google.type.postal_address_pb2.PostalAddress): - Required. Postal address of the contact. - email (str): - Required. Email address of the contact. - phone_number (str): - Required. Phone number of the contact in international - format. For example, ``"+1-800-555-0123"``. - fax_number (str): - Fax number of the contact in international format. For - example, ``"+1-800-555-0123"``. - """ - - postal_address: postal_address_pb2.PostalAddress = proto.Field( - proto.MESSAGE, - number=1, - message=postal_address_pb2.PostalAddress, - ) - email: str = proto.Field( - proto.STRING, - number=2, - ) - phone_number: str = proto.Field( - proto.STRING, - number=3, - ) - fax_number: str = proto.Field( - proto.STRING, - number=4, - ) - - privacy: 'ContactPrivacy' = proto.Field( - proto.ENUM, - number=1, - enum='ContactPrivacy', - ) - registrant_contact: Contact = proto.Field( - proto.MESSAGE, - number=2, - message=Contact, - ) - admin_contact: Contact = proto.Field( - proto.MESSAGE, - number=3, - message=Contact, - ) - technical_contact: Contact = proto.Field( - proto.MESSAGE, - number=4, - message=Contact, - ) - - -class SearchDomainsRequest(proto.Message): - r"""Request for the ``SearchDomains`` method. - - Attributes: - query (str): - Required. String used to search for available - domain names. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - query: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SearchDomainsResponse(proto.Message): - r"""Response for the ``SearchDomains`` method. - - Attributes: - register_parameters (MutableSequence[google.cloud.domains_v1beta1.types.RegisterParameters]): - Results of the domain name search. - """ - - register_parameters: MutableSequence['RegisterParameters'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='RegisterParameters', - ) - - -class RetrieveRegisterParametersRequest(proto.Message): - r"""Request for the ``RetrieveRegisterParameters`` method. - - Attributes: - domain_name (str): - Required. The domain name. Unicode domain - names must be expressed in Punycode format. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RetrieveRegisterParametersResponse(proto.Message): - r"""Response for the ``RetrieveRegisterParameters`` method. - - Attributes: - register_parameters (google.cloud.domains_v1beta1.types.RegisterParameters): - Parameters to use when calling the ``RegisterDomain`` - method. - """ - - register_parameters: 'RegisterParameters' = proto.Field( - proto.MESSAGE, - number=1, - message='RegisterParameters', - ) - - -class RegisterDomainRequest(proto.Message): - r"""Request for the ``RegisterDomain`` method. - - Attributes: - parent (str): - Required. The parent resource of the ``Registration``. Must - be in the format ``projects/*/locations/*``. - registration (google.cloud.domains_v1beta1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - domain_notices (MutableSequence[google.cloud.domains_v1beta1.types.DomainNotice]): - The list of domain notices that you acknowledge. Call - ``RetrieveRegisterParameters`` to see the notices that need - acknowledgement. - contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): - The list of contact notices that the caller acknowledges. - The notices needed here depend on the values specified in - ``registration.contact_settings``. - yearly_price (google.type.money_pb2.Money): - Required. Yearly price to register or renew - the domain. The value that should be put here - can be obtained from RetrieveRegisterParameters - or SearchDomains calls. - validate_only (bool): - When true, only validation is performed, without actually - registering the domain. Follows: - https://cloud.google.com/apis/design/design_patterns#request_validation - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=2, - message='Registration', - ) - domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='DomainNotice', - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='ContactNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=5, - message=money_pb2.Money, - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=6, - ) - - -class RetrieveTransferParametersRequest(proto.Message): - r"""Request for the ``RetrieveTransferParameters`` method. - - Attributes: - domain_name (str): - Required. The domain name. Unicode domain - names must be expressed in Punycode format. - location (str): - Required. The location. Must be in the format - ``projects/*/locations/*``. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - location: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RetrieveTransferParametersResponse(proto.Message): - r"""Response for the ``RetrieveTransferParameters`` method. - - Attributes: - transfer_parameters (google.cloud.domains_v1beta1.types.TransferParameters): - Parameters to use when calling the ``TransferDomain`` - method. - """ - - transfer_parameters: 'TransferParameters' = proto.Field( - proto.MESSAGE, - number=1, - message='TransferParameters', - ) - - -class TransferDomainRequest(proto.Message): - r"""Request for the ``TransferDomain`` method. - - Attributes: - parent (str): - Required. The parent resource of the ``Registration``. Must - be in the format ``projects/*/locations/*``. - registration (google.cloud.domains_v1beta1.types.Registration): - Required. The complete ``Registration`` resource to be - created. - - You can leave ``registration.dns_settings`` unset to import - the domain's current DNS configuration from its current - registrar. Use this option only if you are sure that the - domain's current DNS service does not cease upon transfer, - as is often the case for DNS services provided for free by - the registrar. - contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): - The list of contact notices that you acknowledge. The - notices needed here depend on the values specified in - ``registration.contact_settings``. - yearly_price (google.type.money_pb2.Money): - Required. Acknowledgement of the price to transfer or renew - the domain for one year. Call ``RetrieveTransferParameters`` - to obtain the price, which you must acknowledge. - authorization_code (google.cloud.domains_v1beta1.types.AuthorizationCode): - The domain's transfer authorization code. You - can obtain this from the domain's current - registrar. - validate_only (bool): - Validate the request without actually - transferring the domain. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=2, - message='Registration', - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='ContactNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=4, - message=money_pb2.Money, - ) - authorization_code: 'AuthorizationCode' = proto.Field( - proto.MESSAGE, - number=5, - message='AuthorizationCode', - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=6, - ) - - -class ListRegistrationsRequest(proto.Message): - r"""Request for the ``ListRegistrations`` method. - - Attributes: - parent (str): - Required. The project and location from which to list - ``Registration``\ s, specified in the format - ``projects/*/locations/*``. - page_size (int): - Maximum number of results to return. - page_token (str): - When set to the ``next_page_token`` from a prior response, - provides the next page of results. - filter (str): - Filter expression to restrict the ``Registration``\ s - returned. - - The expression must specify the field name, a comparison - operator, and the value that you want to use for filtering. - The value must be a string, a number, a boolean, or an enum - value. The comparison operator should be one of =, !=, >, <, - >=, <=, or : for prefix or wildcard matches. - - For example, to filter to a specific domain name, use an - expression like ``domainName="example.com"``. You can also - check for the existence of a field; for example, to find - domains using custom DNS settings, use an expression like - ``dnsSettings.customDns:*``. - - You can also create compound filters by combining - expressions with the ``AND`` and ``OR`` operators. For - example, to find domains that are suspended or have specific - issues flagged, use an expression like - ``(state=SUSPENDED) OR (issue:*)``. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - filter: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListRegistrationsResponse(proto.Message): - r"""Response for the ``ListRegistrations`` method. - - Attributes: - registrations (MutableSequence[google.cloud.domains_v1beta1.types.Registration]): - A list of ``Registration``\ s. - next_page_token (str): - When present, there are more results to retrieve. Set - ``page_token`` to this value on a subsequent call to get the - next page of results. - """ - - @property - def raw_page(self): - return self - - registrations: MutableSequence['Registration'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Registration', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetRegistrationRequest(proto.Message): - r"""Request for the ``GetRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to get, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateRegistrationRequest(proto.Message): - r"""Request for the ``UpdateRegistration`` method. - - Attributes: - registration (google.cloud.domains_v1beta1.types.Registration): - Fields of the ``Registration`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the labels - are being updated, the ``update_mask`` is ``"labels"``. - """ - - registration: 'Registration' = proto.Field( - proto.MESSAGE, - number=1, - message='Registration', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class ConfigureManagementSettingsRequest(proto.Message): - r"""Request for the ``ConfigureManagementSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose management - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - management_settings (google.cloud.domains_v1beta1.types.ManagementSettings): - Fields of the ``ManagementSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the transfer - lock is being updated, the ``update_mask`` is - ``"transfer_lock_state"``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - management_settings: 'ManagementSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='ManagementSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - - -class ConfigureDnsSettingsRequest(proto.Message): - r"""Request for the ``ConfigureDnsSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose DNS - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - dns_settings (google.cloud.domains_v1beta1.types.DnsSettings): - Fields of the ``DnsSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the name - servers are being updated for an existing Custom DNS - configuration, the ``update_mask`` is - ``"custom_dns.name_servers"``. - - When changing the DNS provider from one type to another, - pass the new provider's field name as part of the field - mask. For example, when changing from a Google Domains DNS - configuration to a Custom DNS configuration, the - ``update_mask`` is ``"custom_dns"``. // - validate_only (bool): - Validate the request without actually - updating the DNS settings. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - dns_settings: 'DnsSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='DnsSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=4, - ) - - -class ConfigureContactSettingsRequest(proto.Message): - r"""Request for the ``ConfigureContactSettings`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose contact - settings are being updated, in the format - ``projects/*/locations/*/registrations/*``. - contact_settings (google.cloud.domains_v1beta1.types.ContactSettings): - Fields of the ``ContactSettings`` to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Required. The field mask describing which fields to update - as a comma-separated list. For example, if only the - registrant contact is being updated, the ``update_mask`` is - ``"registrant_contact"``. - contact_notices (MutableSequence[google.cloud.domains_v1beta1.types.ContactNotice]): - The list of contact notices that the caller acknowledges. - The notices needed here depend on the values specified in - ``contact_settings``. - validate_only (bool): - Validate the request without actually - updating the contact settings. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - contact_settings: 'ContactSettings' = proto.Field( - proto.MESSAGE, - number=2, - message='ContactSettings', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - contact_notices: MutableSequence['ContactNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='ContactNotice', - ) - validate_only: bool = proto.Field( - proto.BOOL, - number=5, - ) - - -class ExportRegistrationRequest(proto.Message): - r"""Request for the ``ExportRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to export, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteRegistrationRequest(proto.Message): - r"""Request for the ``DeleteRegistration`` method. - - Attributes: - name (str): - Required. The name of the ``Registration`` to delete, in the - format ``projects/*/locations/*/registrations/*``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class RetrieveAuthorizationCodeRequest(proto.Message): - r"""Request for the ``RetrieveAuthorizationCode`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being retrieved, in the format - ``projects/*/locations/*/registrations/*``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ResetAuthorizationCodeRequest(proto.Message): - r"""Request for the ``ResetAuthorizationCode`` method. - - Attributes: - registration (str): - Required. The name of the ``Registration`` whose - authorization code is being reset, in the format - ``projects/*/locations/*/registrations/*``. - """ - - registration: str = proto.Field( - proto.STRING, - number=1, - ) - - -class RegisterParameters(proto.Message): - r"""Parameters required to register a new domain. - - Attributes: - domain_name (str): - The domain name. Unicode domain names are - expressed in Punycode format. - availability (google.cloud.domains_v1beta1.types.RegisterParameters.Availability): - Indicates whether the domain is available for registration. - This value is accurate when obtained by calling - ``RetrieveRegisterParameters``, but is approximate when - obtained by calling ``SearchDomains``. - supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): - Contact privacy options that the domain - supports. - domain_notices (MutableSequence[google.cloud.domains_v1beta1.types.DomainNotice]): - Notices about special properties of the - domain. - yearly_price (google.type.money_pb2.Money): - Price to register or renew the domain for one - year. - """ - class Availability(proto.Enum): - r"""Possible availability states of a domain name. - - Values: - AVAILABILITY_UNSPECIFIED (0): - The availability is unspecified. - AVAILABLE (1): - The domain is available for registration. - UNAVAILABLE (2): - The domain is not available for registration. - Generally this means it is already registered to - another party. - UNSUPPORTED (3): - The domain is not currently supported by - Cloud Domains, but may be available elsewhere. - UNKNOWN (4): - Cloud Domains is unable to determine domain - availability, generally due to system - maintenance at the domain name registry. - """ - AVAILABILITY_UNSPECIFIED = 0 - AVAILABLE = 1 - UNAVAILABLE = 2 - UNSUPPORTED = 3 - UNKNOWN = 4 - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - availability: Availability = proto.Field( - proto.ENUM, - number=2, - enum=Availability, - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=3, - enum='ContactPrivacy', - ) - domain_notices: MutableSequence['DomainNotice'] = proto.RepeatedField( - proto.ENUM, - number=4, - enum='DomainNotice', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=5, - message=money_pb2.Money, - ) - - -class TransferParameters(proto.Message): - r"""Parameters required to transfer a domain from another - registrar. - - Attributes: - domain_name (str): - The domain name. Unicode domain names are - expressed in Punycode format. - current_registrar (str): - The registrar that currently manages the - domain. - name_servers (MutableSequence[str]): - The name servers that currently store the - configuration of the domain. - transfer_lock_state (google.cloud.domains_v1beta1.types.TransferLockState): - Indicates whether the domain is protected by a transfer - lock. For a transfer to succeed, this must show - ``UNLOCKED``. To unlock a domain, go to its current - registrar. - supported_privacy (MutableSequence[google.cloud.domains_v1beta1.types.ContactPrivacy]): - Contact privacy options that the domain - supports. - yearly_price (google.type.money_pb2.Money): - Price to transfer or renew the domain for one - year. - """ - - domain_name: str = proto.Field( - proto.STRING, - number=1, - ) - current_registrar: str = proto.Field( - proto.STRING, - number=2, - ) - name_servers: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - transfer_lock_state: 'TransferLockState' = proto.Field( - proto.ENUM, - number=4, - enum='TransferLockState', - ) - supported_privacy: MutableSequence['ContactPrivacy'] = proto.RepeatedField( - proto.ENUM, - number=5, - enum='ContactPrivacy', - ) - yearly_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=6, - message=money_pb2.Money, - ) - - -class AuthorizationCode(proto.Message): - r"""Defines an authorization code. - - Attributes: - code (str): - The Authorization Code in ASCII. It can be - used to transfer the domain to or from another - registrar. - """ - - code: str = proto.Field( - proto.STRING, - number=1, - ) - - -class OperationMetadata(proto.Message): - r"""Represents the metadata of the long-running operation. Output - only. - - Attributes: - create_time (google.protobuf.timestamp_pb2.Timestamp): - The time the operation was created. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time the operation finished running. - target (str): - Server-defined resource path for the target - of the operation. - verb (str): - Name of the verb executed by the operation. - status_detail (str): - Human-readable status of the operation, if - any. - api_version (str): - API version used to start the operation. - """ - - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - target: str = proto.Field( - proto.STRING, - number=3, - ) - verb: str = proto.Field( - proto.STRING, - number=4, - ) - status_detail: str = proto.Field( - proto.STRING, - number=5, - ) - api_version: str = proto.Field( - proto.STRING, - number=6, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/mypy.ini b/owl-bot-staging/v1beta1/mypy.ini deleted file mode 100644 index 574c5ae..0000000 --- a/owl-bot-staging/v1beta1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v1beta1/noxfile.py b/owl-bot-staging/v1beta1/noxfile.py deleted file mode 100644 index 286feee..0000000 --- a/owl-bot-staging/v1beta1/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/domains_v1beta1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==4.0.1", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py deleted file mode 100644 index bb0437b..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureContactSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureContactSettings_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 domains_v1beta1 - - -async def sample_configure_contact_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureContactSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py deleted file mode 100644 index 44fcfa8..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_contact_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureContactSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureContactSettings_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 domains_v1beta1 - - -def sample_configure_contact_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureContactSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_contact_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureContactSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py deleted file mode 100644 index 8a3996f..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureDnsSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureDnsSettings_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 domains_v1beta1 - - -async def sample_configure_dns_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureDnsSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py deleted file mode 100644 index bc602c6..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_dns_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureDnsSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureDnsSettings_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 domains_v1beta1 - - -def sample_configure_dns_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureDnsSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_dns_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureDnsSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py deleted file mode 100644 index 58f01da..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureManagementSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureManagementSettings_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 domains_v1beta1 - - -async def sample_configure_management_settings(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureManagementSettings_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py deleted file mode 100644 index 9ad8c8a..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_configure_management_settings_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ConfigureManagementSettings -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ConfigureManagementSettings_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 domains_v1beta1 - - -def sample_configure_management_settings(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ConfigureManagementSettingsRequest( - registration="registration_value", - ) - - # Make the request - operation = client.configure_management_settings(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ConfigureManagementSettings_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py deleted file mode 100644 index c1c7a42..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_DeleteRegistration_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 domains_v1beta1 - - -async def sample_delete_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_DeleteRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py deleted file mode 100644 index 7a63afc..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_delete_registration_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_DeleteRegistration_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 domains_v1beta1 - - -def sample_delete_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.DeleteRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_DeleteRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py deleted file mode 100644 index 72f9e71..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ExportRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ExportRegistration_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 domains_v1beta1 - - -async def sample_export_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ExportRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py deleted file mode 100644 index 1c501b0..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_export_registration_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ExportRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ExportRegistration_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 domains_v1beta1 - - -def sample_export_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ExportRegistrationRequest( - name="name_value", - ) - - # Make the request - operation = client.export_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ExportRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py deleted file mode 100644 index 75c18bd..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_GetRegistration_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 domains_v1beta1 - - -async def sample_get_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_registration(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_GetRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py deleted file mode 100644 index e92a14e..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_get_registration_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_GetRegistration_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 domains_v1beta1 - - -def sample_get_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.GetRegistrationRequest( - name="name_value", - ) - - # Make the request - response = client.get_registration(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_GetRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py deleted file mode 100644 index 86667eb..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListRegistrations -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ListRegistrations_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 domains_v1beta1 - - -async def sample_list_registrations(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END domains_v1beta1_generated_Domains_ListRegistrations_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py deleted file mode 100644 index d16b07b..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_list_registrations_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListRegistrations -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ListRegistrations_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 domains_v1beta1 - - -def sample_list_registrations(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ListRegistrationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_registrations(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END domains_v1beta1_generated_Domains_ListRegistrations_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py deleted file mode 100644 index 3c198ed..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_async.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDomain -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RegisterDomain_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 domains_v1beta1 - - -async def sample_register_domain(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RegisterDomain_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py deleted file mode 100644 index f884730..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_register_domain_sync.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDomain -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RegisterDomain_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 domains_v1beta1 - - -def sample_register_domain(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.RegisterDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.register_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RegisterDomain_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py deleted file mode 100644 index 975b01d..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ResetAuthorizationCode -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ResetAuthorizationCode_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 domains_v1beta1 - - -async def sample_reset_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.reset_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ResetAuthorizationCode_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py deleted file mode 100644 index 27d4d98..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_reset_authorization_code_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ResetAuthorizationCode -# 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-domains - - -# [START domains_v1beta1_generated_Domains_ResetAuthorizationCode_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 domains_v1beta1 - - -def sample_reset_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.ResetAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.reset_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_ResetAuthorizationCode_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py deleted file mode 100644 index b34393e..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveAuthorizationCode -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1beta1 - - -async def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = await client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py deleted file mode 100644 index f3c6a9d..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveAuthorizationCode -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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 domains_v1beta1 - - -def sample_retrieve_authorization_code(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveAuthorizationCodeRequest( - registration="registration_value", - ) - - # Make the request - response = client.retrieve_authorization_code(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py deleted file mode 100644 index 20cab05..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveRegisterParameters -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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 domains_v1beta1 - - -async def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveRegisterParameters_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py deleted file mode 100644 index 2a84363..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveRegisterParameters -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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 domains_v1beta1 - - -def sample_retrieve_register_parameters(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveRegisterParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_register_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveRegisterParameters_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py deleted file mode 100644 index 782911a..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveTransferParameters -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveTransferParameters_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 domains_v1beta1 - - -async def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = await client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveTransferParameters_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py deleted file mode 100644 index 47d7e44..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RetrieveTransferParameters -# 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-domains - - -# [START domains_v1beta1_generated_Domains_RetrieveTransferParameters_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 domains_v1beta1 - - -def sample_retrieve_transfer_parameters(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.RetrieveTransferParametersRequest( - domain_name="domain_name_value", - location="location_value", - ) - - # Make the request - response = client.retrieve_transfer_parameters(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_RetrieveTransferParameters_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py deleted file mode 100644 index 13021af..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SearchDomains -# 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-domains - - -# [START domains_v1beta1_generated_Domains_SearchDomains_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 domains_v1beta1 - - -async def sample_search_domains(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = await client.search_domains(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_SearchDomains_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py deleted file mode 100644 index bbaa28a..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_search_domains_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SearchDomains -# 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-domains - - -# [START domains_v1beta1_generated_Domains_SearchDomains_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 domains_v1beta1 - - -def sample_search_domains(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.SearchDomainsRequest( - query="query_value", - location="location_value", - ) - - # Make the request - response = client.search_domains(request=request) - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_SearchDomains_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py deleted file mode 100644 index f63c76c..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_async.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for TransferDomain -# 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-domains - - -# [START domains_v1beta1_generated_Domains_TransferDomain_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 domains_v1beta1 - - -async def sample_transfer_domain(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_TransferDomain_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py deleted file mode 100644 index d406add..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_transfer_domain_sync.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for TransferDomain -# 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-domains - - -# [START domains_v1beta1_generated_Domains_TransferDomain_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 domains_v1beta1 - - -def sample_transfer_domain(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - registration = domains_v1beta1.Registration() - registration.domain_name = "domain_name_value" - registration.contact_settings.privacy = "REDACTED_CONTACT_DATA" - registration.contact_settings.registrant_contact.email = "email_value" - registration.contact_settings.registrant_contact.phone_number = "phone_number_value" - registration.contact_settings.admin_contact.email = "email_value" - registration.contact_settings.admin_contact.phone_number = "phone_number_value" - registration.contact_settings.technical_contact.email = "email_value" - registration.contact_settings.technical_contact.phone_number = "phone_number_value" - - request = domains_v1beta1.TransferDomainRequest( - parent="parent_value", - registration=registration, - ) - - # Make the request - operation = client.transfer_domain(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_TransferDomain_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py deleted file mode 100644 index 2808bff..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_async.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_UpdateRegistration_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 domains_v1beta1 - - -async def sample_update_registration(): - # Create a client - client = domains_v1beta1.DomainsAsyncClient() - - # Initialize request argument(s) - request = domains_v1beta1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_UpdateRegistration_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py deleted file mode 100644 index 28f8559..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/domains_v1beta1_generated_domains_update_registration_sync.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateRegistration -# 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-domains - - -# [START domains_v1beta1_generated_Domains_UpdateRegistration_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 domains_v1beta1 - - -def sample_update_registration(): - # Create a client - client = domains_v1beta1.DomainsClient() - - # Initialize request argument(s) - request = domains_v1beta1.UpdateRegistrationRequest( - ) - - # Make the request - operation = client.update_registration(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END domains_v1beta1_generated_Domains_UpdateRegistration_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json b/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json deleted file mode 100644 index 7634af9..0000000 --- a/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.domains.v1beta1.json +++ /dev/null @@ -1,2550 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.domains.v1beta1", - "version": "v1beta1" - } - ], - "language": "PYTHON", - "name": "google-cloud-domains", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_contact_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureContactSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureContactSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "contact_settings", - "type": "google.cloud.domains_v1beta1.types.ContactSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_contact_settings" - }, - "description": "Sample for ConfigureContactSettings", - "file": "domains_v1beta1_generated_domains_configure_contact_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureContactSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_contact_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_contact_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureContactSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureContactSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureContactSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "contact_settings", - "type": "google.cloud.domains_v1beta1.types.ContactSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_contact_settings" - }, - "description": "Sample for ConfigureContactSettings", - "file": "domains_v1beta1_generated_domains_configure_contact_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureContactSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_contact_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_dns_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureDnsSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureDnsSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "dns_settings", - "type": "google.cloud.domains_v1beta1.types.DnsSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_dns_settings" - }, - "description": "Sample for ConfigureDnsSettings", - "file": "domains_v1beta1_generated_domains_configure_dns_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureDnsSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_dns_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_dns_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureDnsSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureDnsSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureDnsSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "dns_settings", - "type": "google.cloud.domains_v1beta1.types.DnsSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_dns_settings" - }, - "description": "Sample for ConfigureDnsSettings", - "file": "domains_v1beta1_generated_domains_configure_dns_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureDnsSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_dns_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.configure_management_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureManagementSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureManagementSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "management_settings", - "type": "google.cloud.domains_v1beta1.types.ManagementSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "configure_management_settings" - }, - "description": "Sample for ConfigureManagementSettings", - "file": "domains_v1beta1_generated_domains_configure_management_settings_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureManagementSettings_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_management_settings_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.configure_management_settings", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ConfigureManagementSettings", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ConfigureManagementSettings" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ConfigureManagementSettingsRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "management_settings", - "type": "google.cloud.domains_v1beta1.types.ManagementSettings" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "configure_management_settings" - }, - "description": "Sample for ConfigureManagementSettings", - "file": "domains_v1beta1_generated_domains_configure_management_settings_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ConfigureManagementSettings_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_configure_management_settings_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.delete_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.DeleteRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "DeleteRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.DeleteRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "delete_registration" - }, - "description": "Sample for DeleteRegistration", - "file": "domains_v1beta1_generated_domains_delete_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_DeleteRegistration_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_delete_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.delete_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.DeleteRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "DeleteRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.DeleteRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "delete_registration" - }, - "description": "Sample for DeleteRegistration", - "file": "domains_v1beta1_generated_domains_delete_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_DeleteRegistration_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_delete_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.export_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ExportRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ExportRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ExportRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "export_registration" - }, - "description": "Sample for ExportRegistration", - "file": "domains_v1beta1_generated_domains_export_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ExportRegistration_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_export_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.export_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ExportRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ExportRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ExportRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "export_registration" - }, - "description": "Sample for ExportRegistration", - "file": "domains_v1beta1_generated_domains_export_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ExportRegistration_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_export_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.get_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.GetRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "GetRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.GetRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.Registration", - "shortName": "get_registration" - }, - "description": "Sample for GetRegistration", - "file": "domains_v1beta1_generated_domains_get_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_GetRegistration_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": "domains_v1beta1_generated_domains_get_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.get_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.GetRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "GetRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.GetRegistrationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.Registration", - "shortName": "get_registration" - }, - "description": "Sample for GetRegistration", - "file": "domains_v1beta1_generated_domains_get_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_GetRegistration_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": "domains_v1beta1_generated_domains_get_registration_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.list_registrations", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ListRegistrations", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ListRegistrations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ListRegistrationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsAsyncPager", - "shortName": "list_registrations" - }, - "description": "Sample for ListRegistrations", - "file": "domains_v1beta1_generated_domains_list_registrations_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ListRegistrations_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": "domains_v1beta1_generated_domains_list_registrations_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.list_registrations", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ListRegistrations", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ListRegistrations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ListRegistrationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.services.domains.pagers.ListRegistrationsPager", - "shortName": "list_registrations" - }, - "description": "Sample for ListRegistrations", - "file": "domains_v1beta1_generated_domains_list_registrations_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ListRegistrations_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": "domains_v1beta1_generated_domains_list_registrations_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.register_domain", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RegisterDomain", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RegisterDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RegisterDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "register_domain" - }, - "description": "Sample for RegisterDomain", - "file": "domains_v1beta1_generated_domains_register_domain_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RegisterDomain_async", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_register_domain_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.register_domain", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RegisterDomain", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RegisterDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RegisterDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "register_domain" - }, - "description": "Sample for RegisterDomain", - "file": "domains_v1beta1_generated_domains_register_domain_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RegisterDomain_sync", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_register_domain_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.reset_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ResetAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ResetAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", - "shortName": "reset_authorization_code" - }, - "description": "Sample for ResetAuthorizationCode", - "file": "domains_v1beta1_generated_domains_reset_authorization_code_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ResetAuthorizationCode_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": "domains_v1beta1_generated_domains_reset_authorization_code_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.reset_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.ResetAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "ResetAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.ResetAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", - "shortName": "reset_authorization_code" - }, - "description": "Sample for ResetAuthorizationCode", - "file": "domains_v1beta1_generated_domains_reset_authorization_code_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_ResetAuthorizationCode_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": "domains_v1beta1_generated_domains_reset_authorization_code_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", - "shortName": "retrieve_authorization_code" - }, - "description": "Sample for RetrieveAuthorizationCode", - "file": "domains_v1beta1_generated_domains_retrieve_authorization_code_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1beta1_generated_domains_retrieve_authorization_code_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_authorization_code", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveAuthorizationCode", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveAuthorizationCode" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveAuthorizationCodeRequest" - }, - { - "name": "registration", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.AuthorizationCode", - "shortName": "retrieve_authorization_code" - }, - "description": "Sample for RetrieveAuthorizationCode", - "file": "domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveAuthorizationCode_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": "domains_v1beta1_generated_domains_retrieve_authorization_code_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_register_parameters", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveRegisterParameters", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveRegisterParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse", - "shortName": "retrieve_register_parameters" - }, - "description": "Sample for RetrieveRegisterParameters", - "file": "domains_v1beta1_generated_domains_retrieve_register_parameters_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1beta1_generated_domains_retrieve_register_parameters_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_register_parameters", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveRegisterParameters", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveRegisterParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.RetrieveRegisterParametersResponse", - "shortName": "retrieve_register_parameters" - }, - "description": "Sample for RetrieveRegisterParameters", - "file": "domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveRegisterParameters_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": "domains_v1beta1_generated_domains_retrieve_register_parameters_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.retrieve_transfer_parameters", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveTransferParameters", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveTransferParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse", - "shortName": "retrieve_transfer_parameters" - }, - "description": "Sample for RetrieveTransferParameters", - "file": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveTransferParameters_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": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.retrieve_transfer_parameters", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.RetrieveTransferParameters", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "RetrieveTransferParameters" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "domain_name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.RetrieveTransferParametersResponse", - "shortName": "retrieve_transfer_parameters" - }, - "description": "Sample for RetrieveTransferParameters", - "file": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_RetrieveTransferParameters_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": "domains_v1beta1_generated_domains_retrieve_transfer_parameters_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.search_domains", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.SearchDomains", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "SearchDomains" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.SearchDomainsRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.SearchDomainsResponse", - "shortName": "search_domains" - }, - "description": "Sample for SearchDomains", - "file": "domains_v1beta1_generated_domains_search_domains_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_SearchDomains_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": "domains_v1beta1_generated_domains_search_domains_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.search_domains", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.SearchDomains", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "SearchDomains" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.SearchDomainsRequest" - }, - { - "name": "location", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.domains_v1beta1.types.SearchDomainsResponse", - "shortName": "search_domains" - }, - "description": "Sample for SearchDomains", - "file": "domains_v1beta1_generated_domains_search_domains_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_SearchDomains_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": "domains_v1beta1_generated_domains_search_domains_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.transfer_domain", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.TransferDomain", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "TransferDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.TransferDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "authorization_code", - "type": "google.cloud.domains_v1beta1.types.AuthorizationCode" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "transfer_domain" - }, - "description": "Sample for TransferDomain", - "file": "domains_v1beta1_generated_domains_transfer_domain_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_TransferDomain_async", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_transfer_domain_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.transfer_domain", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.TransferDomain", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "TransferDomain" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.TransferDomainRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "yearly_price", - "type": "google.type.money_pb2.Money" - }, - { - "name": "authorization_code", - "type": "google.cloud.domains_v1beta1.types.AuthorizationCode" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "transfer_domain" - }, - "description": "Sample for TransferDomain", - "file": "domains_v1beta1_generated_domains_transfer_domain_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_TransferDomain_sync", - "segments": [ - { - "end": 66, - "start": 27, - "type": "FULL" - }, - { - "end": 66, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 63, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 67, - "start": 64, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_transfer_domain_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient", - "shortName": "DomainsAsyncClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsAsyncClient.update_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.UpdateRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "UpdateRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.UpdateRegistrationRequest" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "update_registration" - }, - "description": "Sample for UpdateRegistration", - "file": "domains_v1beta1_generated_domains_update_registration_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_UpdateRegistration_async", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_update_registration_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.domains_v1beta1.DomainsClient", - "shortName": "DomainsClient" - }, - "fullName": "google.cloud.domains_v1beta1.DomainsClient.update_registration", - "method": { - "fullName": "google.cloud.domains.v1beta1.Domains.UpdateRegistration", - "service": { - "fullName": "google.cloud.domains.v1beta1.Domains", - "shortName": "Domains" - }, - "shortName": "UpdateRegistration" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.domains_v1beta1.types.UpdateRegistrationRequest" - }, - { - "name": "registration", - "type": "google.cloud.domains_v1beta1.types.Registration" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "update_registration" - }, - "description": "Sample for UpdateRegistration", - "file": "domains_v1beta1_generated_domains_update_registration_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "domains_v1beta1_generated_Domains_UpdateRegistration_sync", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "domains_v1beta1_generated_domains_update_registration_sync.py" - } - ] -} diff --git a/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py b/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py deleted file mode 100644 index 39c812d..0000000 --- a/owl-bot-staging/v1beta1/scripts/fixup_domains_v1beta1_keywords.py +++ /dev/null @@ -1,190 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class domainsCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'configure_contact_settings': ('registration', 'update_mask', 'contact_settings', 'contact_notices', 'validate_only', ), - 'configure_dns_settings': ('registration', 'update_mask', 'dns_settings', 'validate_only', ), - 'configure_management_settings': ('registration', 'update_mask', 'management_settings', ), - 'delete_registration': ('name', ), - 'export_registration': ('name', ), - 'get_registration': ('name', ), - 'list_registrations': ('parent', 'page_size', 'page_token', 'filter', ), - 'register_domain': ('parent', 'registration', 'yearly_price', 'domain_notices', 'contact_notices', 'validate_only', ), - 'reset_authorization_code': ('registration', ), - 'retrieve_authorization_code': ('registration', ), - 'retrieve_register_parameters': ('domain_name', 'location', ), - 'retrieve_transfer_parameters': ('domain_name', 'location', ), - 'search_domains': ('query', 'location', ), - 'transfer_domain': ('parent', 'registration', 'yearly_price', 'contact_notices', 'authorization_code', 'validate_only', ), - 'update_registration': ('update_mask', 'registration', ), - } - - 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=domainsCallTransformer(), -): - """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 domains 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/v1beta1/setup.py b/owl-bot-staging/v1beta1/setup.py deleted file mode 100644 index 70be905..0000000 --- a/owl-bot-staging/v1beta1/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-domains' - - -description = "Google Cloud Domains API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/domains/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-domains" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.10.txt b/owl-bot-staging/v1beta1/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.11.txt b/owl-bot-staging/v1beta1/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.12.txt b/owl-bot-staging/v1beta1/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.7.txt b/owl-bot-staging/v1beta1/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +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.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.8.txt b/owl-bot-staging/v1beta1/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.9.txt b/owl-bot-staging/v1beta1/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1beta1/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v1beta1/tests/__init__.py b/owl-bot-staging/v1beta1/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1beta1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/__init__.py b/owl-bot-staging/v1beta1/tests/unit/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py b/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py deleted file mode 100644 index 9063619..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/domains_v1beta1/test_domains.py +++ /dev/null @@ -1,8728 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import future -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import operation -from google.api_core import operation_async # type: ignore -from google.api_core import operations_v1 -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.domains_v1beta1.services.domains import DomainsAsyncClient -from google.cloud.domains_v1beta1.services.domains import DomainsClient -from google.cloud.domains_v1beta1.services.domains import pagers -from google.cloud.domains_v1beta1.services.domains import transports -from google.cloud.domains_v1beta1.types import domains -from google.longrunning import operations_pb2 -from google.oauth2 import service_account -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore -from google.type import postal_address_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert DomainsClient._get_default_mtls_endpoint(None) is None - assert DomainsClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert DomainsClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (DomainsClient, "grpc"), - (DomainsAsyncClient, "grpc_asyncio"), - (DomainsClient, "rest"), -]) -def test_domains_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 == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://domains.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.DomainsGrpcTransport, "grpc"), - (transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.DomainsRestTransport, "rest"), -]) -def test_domains_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", [ - (DomainsClient, "grpc"), - (DomainsAsyncClient, "grpc_asyncio"), - (DomainsClient, "rest"), -]) -def test_domains_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 == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://domains.googleapis.com' - ) - - -def test_domains_client_get_transport_class(): - transport = DomainsClient.get_transport_class() - available_transports = [ - transports.DomainsGrpcTransport, - transports.DomainsRestTransport, - ] - assert transport in available_transports - - transport = DomainsClient.get_transport_class("grpc") - assert transport == transports.DomainsGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (DomainsClient, transports.DomainsRestTransport, "rest"), -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -def test_domains_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(DomainsClient, '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(DomainsClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class(transport=transport_name) - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class(transport=transport_name) - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", "true"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (DomainsClient, transports.DomainsGrpcTransport, "grpc", "false"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (DomainsClient, transports.DomainsRestTransport, "rest", "true"), - (DomainsClient, transports.DomainsRestTransport, "rest", "false"), -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_domains_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class", [ - DomainsClient, DomainsAsyncClient -]) -@mock.patch.object(DomainsClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsClient)) -@mock.patch.object(DomainsAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(DomainsAsyncClient)) -def test_domains_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc"), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio"), - (DomainsClient, transports.DomainsRestTransport, "rest"), -]) -def test_domains_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (DomainsClient, transports.DomainsRestTransport, "rest", None), -]) -def test_domains_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -def test_domains_client_client_options_from_dict(): - with mock.patch('google.cloud.domains_v1beta1.services.domains.transports.DomainsGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = DomainsClient( - 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", [ - (DomainsClient, transports.DomainsGrpcTransport, "grpc", grpc_helpers), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_domains_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "domains.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="domains.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - domains.SearchDomainsRequest, - dict, -]) -def test_search_domains(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse( - ) - response = client.search_domains(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -def test_search_domains_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - client.search_domains() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - -@pytest.mark.asyncio -async def test_search_domains_async(transport: str = 'grpc_asyncio', request_type=domains.SearchDomainsRequest): - client = DomainsAsyncClient( - 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_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse( - )) - response = await client.search_domains(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.SearchDomainsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -@pytest.mark.asyncio -async def test_search_domains_async_from_dict(): - await test_search_domains_async(request_type=dict) - - -def test_search_domains_field_headers(): - client = DomainsClient( - 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 = domains.SearchDomainsRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - call.return_value = domains.SearchDomainsResponse() - client.search_domains(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_search_domains_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.SearchDomainsRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) - await client.search_domains(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_search_domains_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_domains( - location='location_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].query - mock_val = 'query_value' - assert arg == mock_val - - -def test_search_domains_flattened_error(): - client = DomainsClient( - 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_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - -@pytest.mark.asyncio -async def test_search_domains_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_domains), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.SearchDomainsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.SearchDomainsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_domains( - location='location_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].query - mock_val = 'query_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_search_domains_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveRegisterParametersRequest, - dict, -]) -def test_retrieve_register_parameters(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse( - ) - response = client.retrieve_register_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -def test_retrieve_register_parameters_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - client.retrieve_register_parameters() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveRegisterParametersRequest): - client = DomainsAsyncClient( - 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.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse( - )) - response = await client.retrieve_register_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveRegisterParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_async_from_dict(): - await test_retrieve_register_parameters_async(request_type=dict) - - -def test_retrieve_register_parameters_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveRegisterParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - call.return_value = domains.RetrieveRegisterParametersResponse() - client.retrieve_register_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveRegisterParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) - await client.retrieve_register_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_retrieve_register_parameters_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_register_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - - -def test_retrieve_register_parameters_flattened_error(): - client = DomainsClient( - 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.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_register_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveRegisterParametersResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveRegisterParametersResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_register_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_register_parameters_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RegisterDomainRequest, - dict, -]) -def test_register_domain(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.register_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_register_domain_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - client.register_domain() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - -@pytest.mark.asyncio -async def test_register_domain_async(transport: str = 'grpc_asyncio', request_type=domains.RegisterDomainRequest): - client = DomainsAsyncClient( - 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.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.register_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RegisterDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_register_domain_async_from_dict(): - await test_register_domain_async(request_type=dict) - - -def test_register_domain_field_headers(): - client = DomainsClient( - 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 = domains.RegisterDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.register_domain(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_register_domain_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RegisterDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.register_domain(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_register_domain_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.register_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - - -def test_register_domain_flattened_error(): - client = DomainsClient( - 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.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - -@pytest.mark.asyncio -async def test_register_domain_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.register_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_register_domain_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveTransferParametersRequest, - dict, -]) -def test_retrieve_transfer_parameters(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse( - ) - response = client.retrieve_transfer_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -def test_retrieve_transfer_parameters_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - client.retrieve_transfer_parameters() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveTransferParametersRequest): - client = DomainsAsyncClient( - 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.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse( - )) - response = await client.retrieve_transfer_parameters(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveTransferParametersRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_async_from_dict(): - await test_retrieve_transfer_parameters_async(request_type=dict) - - -def test_retrieve_transfer_parameters_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveTransferParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - call.return_value = domains.RetrieveTransferParametersResponse() - client.retrieve_transfer_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveTransferParametersRequest() - - request.location = 'location_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) - await client.retrieve_transfer_parameters(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', - 'location=location_value', - ) in kw['metadata'] - - -def test_retrieve_transfer_parameters_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_transfer_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - - -def test_retrieve_transfer_parameters_flattened_error(): - client = DomainsClient( - 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.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_transfer_parameters), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.RetrieveTransferParametersResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.RetrieveTransferParametersResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_transfer_parameters( - location='location_value', - domain_name='domain_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].location - mock_val = 'location_value' - assert arg == mock_val - arg = args[0].domain_name - mock_val = 'domain_name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_transfer_parameters_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.TransferDomainRequest, - dict, -]) -def test_transfer_domain(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.transfer_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_transfer_domain_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - client.transfer_domain() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - -@pytest.mark.asyncio -async def test_transfer_domain_async(transport: str = 'grpc_asyncio', request_type=domains.TransferDomainRequest): - client = DomainsAsyncClient( - 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.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.transfer_domain(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.TransferDomainRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_transfer_domain_async_from_dict(): - await test_transfer_domain_async(request_type=dict) - - -def test_transfer_domain_field_headers(): - client = DomainsClient( - 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 = domains.TransferDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.transfer_domain(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_transfer_domain_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.TransferDomainRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.transfer_domain(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_transfer_domain_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.transfer_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - arg = args[0].authorization_code - mock_val = domains.AuthorizationCode(code='code_value') - assert arg == mock_val - - -def test_transfer_domain_flattened_error(): - client = DomainsClient( - 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.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - -@pytest.mark.asyncio -async def test_transfer_domain_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.transfer_domain), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.transfer_domain( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_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].registration - mock_val = domains.Registration(name='name_value') - assert arg == mock_val - arg = args[0].yearly_price - mock_val = money_pb2.Money(currency_code='currency_code_value') - assert arg == mock_val - arg = args[0].authorization_code - mock_val = domains.AuthorizationCode(code='code_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_transfer_domain_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ListRegistrationsRequest, - dict, -]) -def test_list_registrations(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_registrations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_registrations_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - client.list_registrations() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - -@pytest.mark.asyncio -async def test_list_registrations_async(transport: str = 'grpc_asyncio', request_type=domains.ListRegistrationsRequest): - client = DomainsAsyncClient( - 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_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_registrations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ListRegistrationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_registrations_async_from_dict(): - await test_list_registrations_async(request_type=dict) - - -def test_list_registrations_field_headers(): - client = DomainsClient( - 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 = domains.ListRegistrationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - call.return_value = domains.ListRegistrationsResponse() - client.list_registrations(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_registrations_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ListRegistrationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) - await client.list_registrations(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_registrations_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_registrations( - 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_registrations_flattened_error(): - client = DomainsClient( - 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_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_registrations_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.ListRegistrationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.ListRegistrationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_registrations( - 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_registrations_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - - -def test_list_registrations_pager(transport_name: str = "grpc"): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_registrations(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, domains.Registration) - for i in results) -def test_list_registrations_pages(transport_name: str = "grpc"): - client = DomainsClient( - 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_registrations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - pages = list(client.list_registrations(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_registrations_async_pager(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_registrations(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, domains.Registration) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_registrations_async_pages(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_registrations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_registrations(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - domains.GetRegistrationRequest, - dict, -]) -def test_get_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - ) - response = client.get_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -def test_get_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - client.get_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - -@pytest.mark.asyncio -async def test_get_registration_async(transport: str = 'grpc_asyncio', request_type=domains.GetRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - )) - response = await client.get_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.GetRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -@pytest.mark.asyncio -async def test_get_registration_async_from_dict(): - await test_get_registration_async(request_type=dict) - - -def test_get_registration_field_headers(): - client = DomainsClient( - 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 = domains.GetRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - call.return_value = domains.Registration() - client.get_registration(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_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.GetRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) - await client.get_registration(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_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_registration( - 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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.Registration() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.Registration()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_registration( - 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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.UpdateRegistrationRequest, - dict, -]) -def test_update_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.update_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_update_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - client.update_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - -@pytest.mark.asyncio -async def test_update_registration_async(transport: str = 'grpc_asyncio', request_type=domains.UpdateRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.update_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.UpdateRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_update_registration_async_from_dict(): - await test_update_registration_async(request_type=dict) - - -def test_update_registration_field_headers(): - client = DomainsClient( - 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 = domains.UpdateRegistrationRequest() - - request.registration.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.update_registration(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', - 'registration.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.UpdateRegistrationRequest() - - request.registration.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.update_registration(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', - 'registration.name=name_value', - ) in kw['metadata'] - - -def test_update_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_registration( - registration=domains.Registration(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].registration - mock_val = domains.Registration(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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_registration( - registration=domains.Registration(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].registration - mock_val = domains.Registration(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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureManagementSettingsRequest, - dict, -]) -def test_configure_management_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_management_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_management_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - client.configure_management_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_management_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureManagementSettingsRequest): - client = DomainsAsyncClient( - 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.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_management_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureManagementSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_management_settings_async_from_dict(): - await test_configure_management_settings_async(request_type=dict) - - -def test_configure_management_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureManagementSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_management_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_management_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureManagementSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_management_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_management_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_management_settings( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].management_settings - mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_configure_management_settings_flattened_error(): - client = DomainsClient( - 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.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_management_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_management_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_management_settings( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].management_settings - mock_val = domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL) - 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_configure_management_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureDnsSettingsRequest, - dict, -]) -def test_configure_dns_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_dns_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_dns_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - client.configure_dns_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_dns_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureDnsSettingsRequest): - client = DomainsAsyncClient( - 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.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_dns_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureDnsSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_dns_settings_async_from_dict(): - await test_configure_dns_settings_async(request_type=dict) - - -def test_configure_dns_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureDnsSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_dns_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_dns_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureDnsSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_dns_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_dns_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_dns_settings( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].dns_settings - mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error(): - client = DomainsClient( - 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.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_dns_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_dns_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_dns_settings( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].dns_settings - mock_val = domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_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_configure_dns_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureContactSettingsRequest, - dict, -]) -def test_configure_contact_settings(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.configure_contact_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_configure_contact_settings_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - client.configure_contact_settings() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - -@pytest.mark.asyncio -async def test_configure_contact_settings_async(transport: str = 'grpc_asyncio', request_type=domains.ConfigureContactSettingsRequest): - client = DomainsAsyncClient( - 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.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.configure_contact_settings(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ConfigureContactSettingsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_configure_contact_settings_async_from_dict(): - await test_configure_contact_settings_async(request_type=dict) - - -def test_configure_contact_settings_field_headers(): - client = DomainsClient( - 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 = domains.ConfigureContactSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.configure_contact_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_configure_contact_settings_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ConfigureContactSettingsRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.configure_contact_settings(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_configure_contact_settings_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.configure_contact_settings( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].contact_settings - mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_configure_contact_settings_flattened_error(): - client = DomainsClient( - 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.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_configure_contact_settings_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.configure_contact_settings), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.configure_contact_settings( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - 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].registration - mock_val = 'registration_value' - assert arg == mock_val - arg = args[0].contact_settings - mock_val = domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA) - 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_configure_contact_settings_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ExportRegistrationRequest, - dict, -]) -def test_export_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.export_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_export_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - client.export_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - -@pytest.mark.asyncio -async def test_export_registration_async(transport: str = 'grpc_asyncio', request_type=domains.ExportRegistrationRequest): - client = DomainsAsyncClient( - 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.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.export_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ExportRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_export_registration_async_from_dict(): - await test_export_registration_async(request_type=dict) - - -def test_export_registration_field_headers(): - client = DomainsClient( - 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 = domains.ExportRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.export_registration(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_export_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ExportRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.export_registration(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_export_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.export_registration( - 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_export_registration_flattened_error(): - client = DomainsClient( - 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.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_export_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.export_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.export_registration( - 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_export_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.DeleteRegistrationRequest, - dict, -]) -def test_delete_registration(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_registration_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - client.delete_registration() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - -@pytest.mark.asyncio -async def test_delete_registration_async(transport: str = 'grpc_asyncio', request_type=domains.DeleteRegistrationRequest): - client = DomainsAsyncClient( - 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_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_registration(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.DeleteRegistrationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_registration_async_from_dict(): - await test_delete_registration_async(request_type=dict) - - -def test_delete_registration_field_headers(): - client = DomainsClient( - 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 = domains.DeleteRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_registration(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_registration_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.DeleteRegistrationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_registration(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_registration_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_registration( - 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_registration_flattened_error(): - client = DomainsClient( - 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_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_registration_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_registration), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_registration( - 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_registration_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveAuthorizationCodeRequest, - dict, -]) -def test_retrieve_authorization_code(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode( - code='code_value', - ) - response = client.retrieve_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_retrieve_authorization_code_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - client.retrieve_authorization_code() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.RetrieveAuthorizationCodeRequest): - client = DomainsAsyncClient( - 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.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( - code='code_value', - )) - response = await client.retrieve_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.RetrieveAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_async_from_dict(): - await test_retrieve_authorization_code_async(request_type=dict) - - -def test_retrieve_authorization_code_field_headers(): - client = DomainsClient( - 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 = domains.RetrieveAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - call.return_value = domains.AuthorizationCode() - client.retrieve_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.RetrieveAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - await client.retrieve_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_retrieve_authorization_code_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - - -def test_retrieve_authorization_code_flattened_error(): - client = DomainsClient( - 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.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_authorization_code_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ResetAuthorizationCodeRequest, - dict, -]) -def test_reset_authorization_code(request_type, transport: str = 'grpc'): - client = DomainsClient( - 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.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode( - code='code_value', - ) - response = client.reset_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_reset_authorization_code_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - client.reset_authorization_code() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - -@pytest.mark.asyncio -async def test_reset_authorization_code_async(transport: str = 'grpc_asyncio', request_type=domains.ResetAuthorizationCodeRequest): - client = DomainsAsyncClient( - 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.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode( - code='code_value', - )) - response = await client.reset_authorization_code(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == domains.ResetAuthorizationCodeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -@pytest.mark.asyncio -async def test_reset_authorization_code_async_from_dict(): - await test_reset_authorization_code_async(request_type=dict) - - -def test_reset_authorization_code_field_headers(): - client = DomainsClient( - 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 = domains.ResetAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - call.return_value = domains.AuthorizationCode() - client.reset_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_reset_authorization_code_field_headers_async(): - client = DomainsAsyncClient( - 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 = domains.ResetAuthorizationCodeRequest() - - request.registration = 'registration_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - await client.reset_authorization_code(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', - 'registration=registration_value', - ) in kw['metadata'] - - -def test_reset_authorization_code_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.reset_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - - -def test_reset_authorization_code_flattened_error(): - client = DomainsClient( - 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.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - -@pytest.mark.asyncio -async def test_reset_authorization_code_flattened_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.reset_authorization_code), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = domains.AuthorizationCode() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(domains.AuthorizationCode()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.reset_authorization_code( - registration='registration_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].registration - mock_val = 'registration_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_reset_authorization_code_flattened_error_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - - -@pytest.mark.parametrize("request_type", [ - domains.SearchDomainsRequest, - dict, -]) -def test_search_domains_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.SearchDomainsResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.search_domains(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.SearchDomainsResponse) - - -def test_search_domains_rest_required_fields(request_type=domains.SearchDomainsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["query"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "query" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "query" in jsonified_request - assert jsonified_request["query"] == request_init["query"] - - jsonified_request["query"] = 'query_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_domains._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("query", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "query" in jsonified_request - assert jsonified_request["query"] == 'query_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.SearchDomainsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.search_domains(request) - - expected_params = [ - ( - "query", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_search_domains_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.search_domains._get_unset_required_fields({}) - assert set(unset_fields) == (set(("query", )) & set(("query", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_domains_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_search_domains") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_search_domains") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.SearchDomainsRequest.pb(domains.SearchDomainsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.SearchDomainsResponse.to_json(domains.SearchDomainsResponse()) - - request = domains.SearchDomainsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.SearchDomainsResponse() - - client.search_domains(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_search_domains_rest_bad_request(transport: str = 'rest', request_type=domains.SearchDomainsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.search_domains(request) - - -def test_search_domains_rest_flattened(): - client = DomainsClient( - 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 = domains.SearchDomainsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_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 - pb_return_value = domains.SearchDomainsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.search_domains(**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/v1beta1/{location=projects/*/locations/*}/registrations:searchDomains" % client.transport._host, args[1]) - - -def test_search_domains_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_domains( - domains.SearchDomainsRequest(), - location='location_value', - query='query_value', - ) - - -def test_search_domains_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveRegisterParametersRequest, - dict, -]) -def test_retrieve_register_parameters_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.RetrieveRegisterParametersResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_register_parameters(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveRegisterParametersResponse) - - -def test_retrieve_register_parameters_rest_required_fields(request_type=domains.RetrieveRegisterParametersRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["domain_name"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "domainName" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == request_init["domain_name"] - - jsonified_request["domainName"] = 'domain_name_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_register_parameters._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("domain_name", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == 'domain_name_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.RetrieveRegisterParametersResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_register_parameters(request) - - expected_params = [ - ( - "domainName", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_register_parameters_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_register_parameters._get_unset_required_fields({}) - assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_register_parameters_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_register_parameters") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_register_parameters") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveRegisterParametersRequest.pb(domains.RetrieveRegisterParametersRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.RetrieveRegisterParametersResponse.to_json(domains.RetrieveRegisterParametersResponse()) - - request = domains.RetrieveRegisterParametersRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.RetrieveRegisterParametersResponse() - - client.retrieve_register_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_register_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveRegisterParametersRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_register_parameters(request) - - -def test_retrieve_register_parameters_rest_flattened(): - client = DomainsClient( - 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 = domains.RetrieveRegisterParametersResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_value', - domain_name='domain_name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveRegisterParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_register_parameters(**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/v1beta1/{location=projects/*/locations/*}/registrations:retrieveRegisterParameters" % client.transport._host, args[1]) - - -def test_retrieve_register_parameters_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_register_parameters( - domains.RetrieveRegisterParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -def test_retrieve_register_parameters_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RegisterDomainRequest, - dict, -]) -def test_register_domain_rest(request_type): - client = DomainsClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_domain(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_register_domain_rest_required_fields(request_type=domains.RegisterDomainRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_domain._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()).register_domain._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_domain(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_domain_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_domain._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_domain_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_register_domain") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_register_domain") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RegisterDomainRequest.pb(domains.RegisterDomainRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.RegisterDomainRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.register_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_domain_rest_bad_request(transport: str = 'rest', request_type=domains.RegisterDomainRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_domain(request) - - -def test_register_domain_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_domain(**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/v1beta1/{parent=projects/*/locations/*}/registrations:register" % client.transport._host, args[1]) - - -def test_register_domain_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.register_domain( - domains.RegisterDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - ) - - -def test_register_domain_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveTransferParametersRequest, - dict, -]) -def test_retrieve_transfer_parameters_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'location': '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 = domains.RetrieveTransferParametersResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_transfer_parameters(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.RetrieveTransferParametersResponse) - - -def test_retrieve_transfer_parameters_rest_required_fields(request_type=domains.RetrieveTransferParametersRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["domain_name"] = "" - request_init["location"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "domainName" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == request_init["domain_name"] - - jsonified_request["domainName"] = 'domain_name_value' - jsonified_request["location"] = 'location_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_transfer_parameters._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("domain_name", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "domainName" in jsonified_request - assert jsonified_request["domainName"] == 'domain_name_value' - assert "location" in jsonified_request - assert jsonified_request["location"] == 'location_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.RetrieveTransferParametersResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_transfer_parameters(request) - - expected_params = [ - ( - "domainName", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_transfer_parameters_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_transfer_parameters._get_unset_required_fields({}) - assert set(unset_fields) == (set(("domainName", )) & set(("domainName", "location", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_transfer_parameters_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_transfer_parameters") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_transfer_parameters") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveTransferParametersRequest.pb(domains.RetrieveTransferParametersRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.RetrieveTransferParametersResponse.to_json(domains.RetrieveTransferParametersResponse()) - - request = domains.RetrieveTransferParametersRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.RetrieveTransferParametersResponse() - - client.retrieve_transfer_parameters(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_transfer_parameters_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveTransferParametersRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'location': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_transfer_parameters(request) - - -def test_retrieve_transfer_parameters_rest_flattened(): - client = DomainsClient( - 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 = domains.RetrieveTransferParametersResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'location': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - location='location_value', - domain_name='domain_name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.RetrieveTransferParametersResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_transfer_parameters(**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/v1beta1/{location=projects/*/locations/*}/registrations:retrieveTransferParameters" % client.transport._host, args[1]) - - -def test_retrieve_transfer_parameters_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_transfer_parameters( - domains.RetrieveTransferParametersRequest(), - location='location_value', - domain_name='domain_name_value', - ) - - -def test_retrieve_transfer_parameters_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.TransferDomainRequest, - dict, -]) -def test_transfer_domain_rest(request_type): - client = DomainsClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.transfer_domain(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_transfer_domain_rest_required_fields(request_type=domains.TransferDomainRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).transfer_domain._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()).transfer_domain._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.transfer_domain(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_transfer_domain_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.transfer_domain._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "registration", "yearlyPrice", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_transfer_domain_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_transfer_domain") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_transfer_domain") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.TransferDomainRequest.pb(domains.TransferDomainRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.TransferDomainRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.transfer_domain(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_transfer_domain_rest_bad_request(transport: str = 'rest', request_type=domains.TransferDomainRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.transfer_domain(request) - - -def test_transfer_domain_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.transfer_domain(**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/v1beta1/{parent=projects/*/locations/*}/registrations:transfer" % client.transport._host, args[1]) - - -def test_transfer_domain_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.transfer_domain( - domains.TransferDomainRequest(), - parent='parent_value', - registration=domains.Registration(name='name_value'), - yearly_price=money_pb2.Money(currency_code='currency_code_value'), - authorization_code=domains.AuthorizationCode(code='code_value'), - ) - - -def test_transfer_domain_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ListRegistrationsRequest, - dict, -]) -def test_list_registrations_rest(request_type): - client = DomainsClient( - 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 = domains.ListRegistrationsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_registrations(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRegistrationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_registrations_rest_required_fields(request_type=domains.ListRegistrationsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_registrations._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_registrations._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("filter", "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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.ListRegistrationsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_registrations(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_registrations_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_registrations._get_unset_required_fields({}) - assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_registrations_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_list_registrations") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_list_registrations") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ListRegistrationsRequest.pb(domains.ListRegistrationsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.ListRegistrationsResponse.to_json(domains.ListRegistrationsResponse()) - - request = domains.ListRegistrationsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.ListRegistrationsResponse() - - client.list_registrations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_registrations_rest_bad_request(transport: str = 'rest', request_type=domains.ListRegistrationsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_registrations(request) - - -def test_list_registrations_rest_flattened(): - client = DomainsClient( - 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 = domains.ListRegistrationsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.ListRegistrationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_registrations(**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/v1beta1/{parent=projects/*/locations/*}/registrations" % client.transport._host, args[1]) - - -def test_list_registrations_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registrations( - domains.ListRegistrationsRequest(), - parent='parent_value', - ) - - -def test_list_registrations_rest_pager(transport: str = 'rest'): - client = DomainsClient( - 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 = ( - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - domains.Registration(), - ], - next_page_token='abc', - ), - domains.ListRegistrationsResponse( - registrations=[], - next_page_token='def', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - ], - next_page_token='ghi', - ), - domains.ListRegistrationsResponse( - registrations=[ - domains.Registration(), - domains.Registration(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(domains.ListRegistrationsResponse.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_registrations(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, domains.Registration) - for i in results) - - pages = list(client.list_registrations(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - domains.GetRegistrationRequest, - dict, -]) -def test_get_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/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 = domains.Registration( - name='name_value', - domain_name='domain_name_value', - state=domains.Registration.State.REGISTRATION_PENDING, - issues=[domains.Registration.Issue.CONTACT_SUPPORT], - supported_privacy=[domains.ContactPrivacy.PUBLIC_CONTACT_DATA], - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_registration(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.Registration) - assert response.name == 'name_value' - assert response.domain_name == 'domain_name_value' - assert response.state == domains.Registration.State.REGISTRATION_PENDING - assert response.issues == [domains.Registration.Issue.CONTACT_SUPPORT] - assert response.supported_privacy == [domains.ContactPrivacy.PUBLIC_CONTACT_DATA] - - -def test_get_registration_rest_required_fields(request_type=domains.GetRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_registration._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_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.Registration() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_get_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_get_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.GetRegistrationRequest.pb(domains.GetRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.Registration.to_json(domains.Registration()) - - request = domains.GetRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.Registration() - - client.get_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_registration_rest_bad_request(transport: str = 'rest', request_type=domains.GetRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_registration(request) - - -def test_get_registration_rest_flattened(): - client = DomainsClient( - 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 = domains.Registration() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.Registration.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) - - -def test_get_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.GetRegistrationRequest(), - name='name_value', - ) - - -def test_get_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.UpdateRegistrationRequest, - dict, -]) -def test_update_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_update_registration_rest_required_fields(request_type=domains.UpdateRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_registration._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("update_mask", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "patch", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(("updateMask", )) & set(("updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_update_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_update_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.UpdateRegistrationRequest.pb(domains.UpdateRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.UpdateRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.update_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_registration_rest_bad_request(transport: str = 'rest', request_type=domains.UpdateRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - request_init["registration"] = {'name': 'projects/sample1/locations/sample2/registrations/sample3', 'domain_name': 'domain_name_value', 'create_time': {'seconds': 751, 'nanos': 543}, 'expire_time': {}, 'state': 1, 'issues': [1], 'labels': {}, 'management_settings': {'renewal_method': 1, 'transfer_lock_state': 1}, 'dns_settings': {'custom_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_records': [{'key_tag': 740, 'algorithm': 1, 'digest_type': 1, 'digest': 'digest_value'}]}, 'google_domains_dns': {'name_servers': ['name_servers_value1', 'name_servers_value2'], 'ds_state': 1, 'ds_records': {}}, 'glue_records': [{'host_name': 'host_name_value', 'ipv4_addresses': ['ipv4_addresses_value1', 'ipv4_addresses_value2'], 'ipv6_addresses': ['ipv6_addresses_value1', 'ipv6_addresses_value2']}]}, 'contact_settings': {'privacy': 1, 'registrant_contact': {'postal_address': {'revision': 879, 'region_code': 'region_code_value', 'language_code': 'language_code_value', 'postal_code': 'postal_code_value', 'sorting_code': 'sorting_code_value', 'administrative_area': 'administrative_area_value', 'locality': 'locality_value', 'sublocality': 'sublocality_value', 'address_lines': ['address_lines_value1', 'address_lines_value2'], 'recipients': ['recipients_value1', 'recipients_value2'], 'organization': 'organization_value'}, 'email': 'email_value', 'phone_number': 'phone_number_value', 'fax_number': 'fax_number_value'}, 'admin_contact': {}, 'technical_contact': {}}, 'pending_contact_settings': {}, 'supported_privacy': [1]} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_registration(request) - - -def test_update_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': {'name': 'projects/sample1/locations/sample2/registrations/sample3'}} - - # get truthy value for each flattened field - mock_args = dict( - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_registration(**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/v1beta1/{registration.name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) - - -def test_update_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.UpdateRegistrationRequest(), - registration=domains.Registration(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_update_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureManagementSettingsRequest, - dict, -]) -def test_configure_management_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_management_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_management_settings_rest_required_fields(request_type=domains.ConfigureManagementSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_management_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_management_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_management_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_management_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_management_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_management_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_management_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureManagementSettingsRequest.pb(domains.ConfigureManagementSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureManagementSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_management_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_management_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureManagementSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_management_settings(request) - - -def test_configure_management_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_management_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureManagementSettings" % client.transport._host, args[1]) - - -def test_configure_management_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_management_settings( - domains.ConfigureManagementSettingsRequest(), - registration='registration_value', - management_settings=domains.ManagementSettings(renewal_method=domains.ManagementSettings.RenewalMethod.AUTOMATIC_RENEWAL), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_management_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureDnsSettingsRequest, - dict, -]) -def test_configure_dns_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_dns_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_dns_settings_rest_required_fields(request_type=domains.ConfigureDnsSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_dns_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_dns_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_dns_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_dns_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_dns_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_dns_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_dns_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureDnsSettingsRequest.pb(domains.ConfigureDnsSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureDnsSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_dns_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_dns_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureDnsSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_dns_settings(request) - - -def test_configure_dns_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_dns_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings" % client.transport._host, args[1]) - - -def test_configure_dns_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_dns_settings( - domains.ConfigureDnsSettingsRequest(), - registration='registration_value', - dns_settings=domains.DnsSettings(custom_dns=domains.DnsSettings.CustomDns(name_servers=['name_servers_value'])), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_dns_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ConfigureContactSettingsRequest, - dict, -]) -def test_configure_contact_settings_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.configure_contact_settings(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_configure_contact_settings_rest_required_fields(request_type=domains.ConfigureContactSettingsRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).configure_contact_settings._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.configure_contact_settings(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_configure_contact_settings_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.configure_contact_settings._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", "updateMask", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_configure_contact_settings_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_configure_contact_settings") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_configure_contact_settings") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ConfigureContactSettingsRequest.pb(domains.ConfigureContactSettingsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ConfigureContactSettingsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.configure_contact_settings(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_configure_contact_settings_rest_bad_request(transport: str = 'rest', request_type=domains.ConfigureContactSettingsRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.configure_contact_settings(request) - - -def test_configure_contact_settings_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.configure_contact_settings(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:configureContactSettings" % client.transport._host, args[1]) - - -def test_configure_contact_settings_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.configure_contact_settings( - domains.ConfigureContactSettingsRequest(), - registration='registration_value', - contact_settings=domains.ContactSettings(privacy=domains.ContactPrivacy.PUBLIC_CONTACT_DATA), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_configure_contact_settings_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ExportRegistrationRequest, - dict, -]) -def test_export_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.export_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_export_registration_rest_required_fields(request_type=domains.ExportRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).export_registration._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()).export_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.export_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_export_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.export_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_export_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_export_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_export_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ExportRegistrationRequest.pb(domains.ExportRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.ExportRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.export_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_export_registration_rest_bad_request(transport: str = 'rest', request_type=domains.ExportRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.export_registration(request) - - -def test_export_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.export_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}:export" % client.transport._host, args[1]) - - -def test_export_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.export_registration( - domains.ExportRegistrationRequest(), - name='name_value', - ) - - -def test_export_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.DeleteRegistrationRequest, - dict, -]) -def test_delete_registration_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_registration(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_delete_registration_rest_required_fields(request_type=domains.DeleteRegistrationRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_registration._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_registration._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 = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_registration(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_registration_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_registration._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_registration_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.DomainsRestInterceptor, "post_delete_registration") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_delete_registration") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.DeleteRegistrationRequest.pb(domains.DeleteRegistrationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = domains.DeleteRegistrationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.delete_registration(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_delete_registration_rest_bad_request(transport: str = 'rest', request_type=domains.DeleteRegistrationRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_registration(request) - - -def test_delete_registration_rest_flattened(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_registration(**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/v1beta1/{name=projects/*/locations/*/registrations/*}" % client.transport._host, args[1]) - - -def test_delete_registration_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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_registration( - domains.DeleteRegistrationRequest(), - name='name_value', - ) - - -def test_delete_registration_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.RetrieveAuthorizationCodeRequest, - dict, -]) -def test_retrieve_authorization_code_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( - code='code_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.retrieve_authorization_code(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_retrieve_authorization_code_rest_required_fields(request_type=domains.RetrieveAuthorizationCodeRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).retrieve_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.AuthorizationCode() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.retrieve_authorization_code(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_retrieve_authorization_code_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.retrieve_authorization_code._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_retrieve_authorization_code_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_retrieve_authorization_code") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_retrieve_authorization_code") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.RetrieveAuthorizationCodeRequest.pb(domains.RetrieveAuthorizationCodeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) - - request = domains.RetrieveAuthorizationCodeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.AuthorizationCode() - - client.retrieve_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_retrieve_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.RetrieveAuthorizationCodeRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.retrieve_authorization_code(request) - - -def test_retrieve_authorization_code_rest_flattened(): - client = DomainsClient( - 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 = domains.AuthorizationCode() - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.retrieve_authorization_code(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:retrieveAuthorizationCode" % client.transport._host, args[1]) - - -def test_retrieve_authorization_code_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.retrieve_authorization_code( - domains.RetrieveAuthorizationCodeRequest(), - registration='registration_value', - ) - - -def test_retrieve_authorization_code_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - domains.ResetAuthorizationCodeRequest, - dict, -]) -def test_reset_authorization_code_rest(request_type): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/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 = domains.AuthorizationCode( - code='code_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.reset_authorization_code(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, domains.AuthorizationCode) - assert response.code == 'code_value' - - -def test_reset_authorization_code_rest_required_fields(request_type=domains.ResetAuthorizationCodeRequest): - transport_class = transports.DomainsRestTransport - - request_init = {} - request_init["registration"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["registration"] = 'registration_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).reset_authorization_code._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "registration" in jsonified_request - assert jsonified_request["registration"] == 'registration_value' - - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = domains.AuthorizationCode() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.reset_authorization_code(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_reset_authorization_code_rest_unset_required_fields(): - transport = transports.DomainsRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.reset_authorization_code._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("registration", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_reset_authorization_code_rest_interceptors(null_interceptor): - transport = transports.DomainsRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.DomainsRestInterceptor(), - ) - client = DomainsClient(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.DomainsRestInterceptor, "post_reset_authorization_code") as post, \ - mock.patch.object(transports.DomainsRestInterceptor, "pre_reset_authorization_code") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = domains.ResetAuthorizationCodeRequest.pb(domains.ResetAuthorizationCodeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = domains.AuthorizationCode.to_json(domains.AuthorizationCode()) - - request = domains.ResetAuthorizationCodeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = domains.AuthorizationCode() - - client.reset_authorization_code(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_reset_authorization_code_rest_bad_request(transport: str = 'rest', request_type=domains.ResetAuthorizationCodeRequest): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.reset_authorization_code(request) - - -def test_reset_authorization_code_rest_flattened(): - client = DomainsClient( - 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 = domains.AuthorizationCode() - - # get arguments that satisfy an http rule for this method - sample_request = {'registration': 'projects/sample1/locations/sample2/registrations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - registration='registration_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = domains.AuthorizationCode.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.reset_authorization_code(**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/v1beta1/{registration=projects/*/locations/*/registrations/*}:resetAuthorizationCode" % client.transport._host, args[1]) - - -def test_reset_authorization_code_rest_flattened_error(transport: str = 'rest'): - client = DomainsClient( - 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.reset_authorization_code( - domains.ResetAuthorizationCodeRequest(), - registration='registration_value', - ) - - -def test_reset_authorization_code_rest_error(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = DomainsClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = DomainsClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = DomainsClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = DomainsClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.DomainsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.DomainsGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - transports.DomainsRestTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = DomainsClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.DomainsGrpcTransport, - ) - -def test_domains_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.DomainsTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_domains_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.domains_v1beta1.services.domains.transports.DomainsTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.DomainsTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'search_domains', - 'retrieve_register_parameters', - 'register_domain', - 'retrieve_transfer_parameters', - 'transfer_domain', - 'list_registrations', - 'get_registration', - 'update_registration', - 'configure_management_settings', - 'configure_dns_settings', - 'configure_contact_settings', - 'export_registration', - 'delete_registration', - 'retrieve_authorization_code', - 'reset_authorization_code', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_domains_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.domains_v1beta1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.DomainsTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_domains_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.domains_v1beta1.services.domains.transports.DomainsTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.DomainsTransport() - adc.assert_called_once() - - -def test_domains_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) - DomainsClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - ], -) -def test_domains_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.DomainsGrpcTransport, - transports.DomainsGrpcAsyncIOTransport, - transports.DomainsRestTransport, - ], -) -def test_domains_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.DomainsGrpcTransport, grpc_helpers), - (transports.DomainsGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_domains_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( - "domains.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="domains.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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_domains_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.DomainsRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -def test_domains_rest_lro_client(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.AbstractOperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_domains_host_no_port(transport_name): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'domains.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://domains.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_domains_host_with_port(transport_name): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='domains.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'domains.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://domains.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_domains_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = DomainsClient( - credentials=creds1, - transport=transport_name, - ) - client2 = DomainsClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.search_domains._session - session2 = client2.transport.search_domains._session - assert session1 != session2 - session1 = client1.transport.retrieve_register_parameters._session - session2 = client2.transport.retrieve_register_parameters._session - assert session1 != session2 - session1 = client1.transport.register_domain._session - session2 = client2.transport.register_domain._session - assert session1 != session2 - session1 = client1.transport.retrieve_transfer_parameters._session - session2 = client2.transport.retrieve_transfer_parameters._session - assert session1 != session2 - session1 = client1.transport.transfer_domain._session - session2 = client2.transport.transfer_domain._session - assert session1 != session2 - session1 = client1.transport.list_registrations._session - session2 = client2.transport.list_registrations._session - assert session1 != session2 - session1 = client1.transport.get_registration._session - session2 = client2.transport.get_registration._session - assert session1 != session2 - session1 = client1.transport.update_registration._session - session2 = client2.transport.update_registration._session - assert session1 != session2 - session1 = client1.transport.configure_management_settings._session - session2 = client2.transport.configure_management_settings._session - assert session1 != session2 - session1 = client1.transport.configure_dns_settings._session - session2 = client2.transport.configure_dns_settings._session - assert session1 != session2 - session1 = client1.transport.configure_contact_settings._session - session2 = client2.transport.configure_contact_settings._session - assert session1 != session2 - session1 = client1.transport.export_registration._session - session2 = client2.transport.export_registration._session - assert session1 != session2 - session1 = client1.transport.delete_registration._session - session2 = client2.transport.delete_registration._session - assert session1 != session2 - session1 = client1.transport.retrieve_authorization_code._session - session2 = client2.transport.retrieve_authorization_code._session - assert session1 != session2 - session1 = client1.transport.reset_authorization_code._session - session2 = client2.transport.reset_authorization_code._session - assert session1 != session2 -def test_domains_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.DomainsGrpcTransport( - 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_domains_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.DomainsGrpcAsyncIOTransport( - 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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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.DomainsGrpcTransport, transports.DomainsGrpcAsyncIOTransport]) -def test_domains_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_domains_grpc_lro_client(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_domains_grpc_lro_async_client(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsAsyncClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_registration_path(): - project = "squid" - location = "clam" - registration = "whelk" - expected = "projects/{project}/locations/{location}/registrations/{registration}".format(project=project, location=location, registration=registration, ) - actual = DomainsClient.registration_path(project, location, registration) - assert expected == actual - - -def test_parse_registration_path(): - expected = { - "project": "octopus", - "location": "oyster", - "registration": "nudibranch", - } - path = DomainsClient.registration_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_registration_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = DomainsClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = DomainsClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = DomainsClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = DomainsClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = DomainsClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = DomainsClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = DomainsClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = DomainsClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.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 = DomainsClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = DomainsClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = DomainsClient.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.DomainsTransport, '_prep_wrapped_messages') as prep: - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.DomainsTransport, '_prep_wrapped_messages') as prep: - transport_class = DomainsClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = DomainsAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - - -def test_transport_close(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = DomainsClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'rest', - 'grpc', - ] - for transport in transports: - client = DomainsClient( - 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", [ - (DomainsClient, transports.DomainsGrpcTransport), - (DomainsAsyncClient, transports.DomainsGrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - )