From 0e811d8514e582757b567a9324ae686d43ac3229 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Sat, 17 Jun 2023 00:50:43 +0000 Subject: [PATCH 1/2] feat: added resource_reference for name in GetProjectBillingInfoRequest message PiperOrigin-RevId: 541033608 Source-Link: https://github.com/googleapis/googleapis/commit/f78641709fd23336b303307ac4d55b5582b00fae Source-Link: https://github.com/googleapis/googleapis-gen/commit/c5986a104f1d765ce6b90160e05e6976693b38ef Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbGxpbmcvLk93bEJvdC55YW1sIiwiaCI6ImM1OTg2YTEwNGYxZDc2NWNlNmI5MDE2MGUwNWU2OTc2NjkzYjM4ZWYifQ== --- .../google-cloud-billing/v1/.coveragerc | 13 + .../google-cloud-billing/v1/.flake8 | 33 + .../google-cloud-billing/v1/MANIFEST.in | 2 + .../google-cloud-billing/v1/README.rst | 49 + .../v1/docs/billing_v1/cloud_billing.rst | 10 + .../v1/docs/billing_v1/cloud_catalog.rst | 10 + .../v1/docs/billing_v1/services.rst | 7 + .../v1/docs/billing_v1/types.rst | 6 + .../google-cloud-billing/v1/docs/conf.py | 376 + .../google-cloud-billing/v1/docs/index.rst | 7 + .../v1/google/cloud/billing/__init__.py | 75 + .../v1/google/cloud/billing/gapic_version.py | 16 + .../v1/google/cloud/billing/py.typed | 2 + .../v1/google/cloud/billing_v1/__init__.py | 76 + .../cloud/billing_v1/gapic_metadata.json | 227 + .../google/cloud/billing_v1/gapic_version.py | 16 + .../v1/google/cloud/billing_v1/py.typed | 2 + .../cloud/billing_v1/services/__init__.py | 15 + .../services/cloud_billing/__init__.py | 22 + .../services/cloud_billing/async_client.py | 1508 ++++ .../services/cloud_billing/client.py | 1649 +++++ .../services/cloud_billing/pagers.py | 260 + .../cloud_billing/transports/__init__.py | 38 + .../services/cloud_billing/transports/base.py | 341 + .../services/cloud_billing/transports/grpc.py | 578 ++ .../cloud_billing/transports/grpc_asyncio.py | 577 ++ .../services/cloud_billing/transports/rest.py | 1490 ++++ .../services/cloud_catalog/__init__.py | 22 + .../services/cloud_catalog/async_client.py | 399 ++ .../services/cloud_catalog/client.py | 613 ++ .../services/cloud_catalog/pagers.py | 260 + .../cloud_catalog/transports/__init__.py | 38 + .../services/cloud_catalog/transports/base.py | 164 + .../services/cloud_catalog/transports/grpc.py | 293 + .../cloud_catalog/transports/grpc_asyncio.py | 292 + .../services/cloud_catalog/transports/rest.py | 392 ++ .../google/cloud/billing_v1/types/__init__.py | 66 + .../cloud/billing_v1/types/cloud_billing.py | 377 + .../cloud/billing_v1/types/cloud_catalog.py | 602 ++ .../google-cloud-billing/v1/mypy.ini | 3 + .../google-cloud-billing/v1/noxfile.py | 184 + ...ud_billing_create_billing_account_async.py | 51 + ...oud_billing_create_billing_account_sync.py | 51 + ...cloud_billing_get_billing_account_async.py | 52 + ..._cloud_billing_get_billing_account_sync.py | 52 + ...ated_cloud_billing_get_iam_policy_async.py | 53 + ...rated_cloud_billing_get_iam_policy_sync.py | 53 + ..._billing_get_project_billing_info_async.py | 52 + ...d_billing_get_project_billing_info_sync.py | 52 + ...oud_billing_list_billing_accounts_async.py | 52 + ...loud_billing_list_billing_accounts_sync.py | 52 + ...billing_list_project_billing_info_async.py | 53 + ..._billing_list_project_billing_info_sync.py | 53 + ...ated_cloud_billing_set_iam_policy_async.py | 53 + ...rated_cloud_billing_set_iam_policy_sync.py | 53 + ...loud_billing_test_iam_permissions_async.py | 54 + ...cloud_billing_test_iam_permissions_sync.py | 54 + ...ud_billing_update_billing_account_async.py | 52 + ...oud_billing_update_billing_account_sync.py | 52 + ...lling_update_project_billing_info_async.py | 52 + ...illing_update_project_billing_info_sync.py | 52 + ...rated_cloud_catalog_list_services_async.py | 52 + ...erated_cloud_catalog_list_services_sync.py | 52 + ...generated_cloud_catalog_list_skus_async.py | 53 + ..._generated_cloud_catalog_list_skus_sync.py | 53 + ...ppet_metadata_google.cloud.billing.v1.json | 1955 +++++ .../v1/scripts/fixup_billing_v1_keywords.py | 187 + .../google-cloud-billing/v1/setup.py | 91 + .../v1/testing/constraints-3.10.txt | 7 + .../v1/testing/constraints-3.11.txt | 7 + .../v1/testing/constraints-3.12.txt | 7 + .../v1/testing/constraints-3.7.txt | 10 + .../v1/testing/constraints-3.8.txt | 7 + .../v1/testing/constraints-3.9.txt | 7 + .../google-cloud-billing/v1/tests/__init__.py | 16 + .../v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../tests/unit/gapic/billing_v1/__init__.py | 16 + .../gapic/billing_v1/test_cloud_billing.py | 6262 +++++++++++++++++ .../gapic/billing_v1/test_cloud_catalog.py | 2385 +++++++ 80 files changed, 23357 insertions(+) create mode 100644 owl-bot-staging/google-cloud-billing/v1/.coveragerc create mode 100644 owl-bot-staging/google-cloud-billing/v1/.flake8 create mode 100644 owl-bot-staging/google-cloud-billing/v1/MANIFEST.in create mode 100644 owl-bot-staging/google-cloud-billing/v1/README.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/conf.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/index.rst create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/mypy.ini create mode 100644 owl-bot-staging/google-cloud-billing/v1/noxfile.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json create mode 100644 owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/setup.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py create mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py diff --git a/owl-bot-staging/google-cloud-billing/v1/.coveragerc b/owl-bot-staging/google-cloud-billing/v1/.coveragerc new file mode 100644 index 000000000000..9d5c973460e2 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/billing/__init__.py + google/cloud/billing/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/google-cloud-billing/v1/.flake8 b/owl-bot-staging/google-cloud-billing/v1/.flake8 new file mode 100644 index 000000000000..29227d4cf419 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/MANIFEST.in b/owl-bot-staging/google-cloud-billing/v1/MANIFEST.in new file mode 100644 index 000000000000..c96c710b2dd8 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/billing *.py +recursive-include google/cloud/billing_v1 *.py diff --git a/owl-bot-staging/google-cloud-billing/v1/README.rst b/owl-bot-staging/google-cloud-billing/v1/README.rst new file mode 100644 index 000000000000..d63a58dc0f74 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Billing 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 Billing 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/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst new file mode 100644 index 000000000000..08631bdaf3cf --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst @@ -0,0 +1,10 @@ +CloudBilling +------------------------------ + +.. automodule:: google.cloud.billing_v1.services.cloud_billing + :members: + :inherited-members: + +.. automodule:: google.cloud.billing_v1.services.cloud_billing.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst new file mode 100644 index 000000000000..6795e651418d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst @@ -0,0 +1,10 @@ +CloudCatalog +------------------------------ + +.. automodule:: google.cloud.billing_v1.services.cloud_catalog + :members: + :inherited-members: + +.. automodule:: google.cloud.billing_v1.services.cloud_catalog.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst new file mode 100644 index 000000000000..934883679ee3 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Billing v1 API +======================================== +.. toctree:: + :maxdepth: 2 + + cloud_billing + cloud_catalog diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst new file mode 100644 index 000000000000..75c1f9f0fdc2 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Billing v1 API +===================================== + +.. automodule:: google.cloud.billing_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/conf.py b/owl-bot-staging/google-cloud-billing/v1/docs/conf.py new file mode 100644 index 000000000000..c7a7757a2426 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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-billing 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-billing" +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-billing-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-billing.tex", + u"google-cloud-billing 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-billing", + u"Google Cloud Billing 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-billing", + u"google-cloud-billing Documentation", + author, + "google-cloud-billing", + "GAPIC library for Google Cloud Billing 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/google-cloud-billing/v1/docs/index.rst b/owl-bot-staging/google-cloud-billing/v1/docs/index.rst new file mode 100644 index 000000000000..ba505d00d3b6 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + billing_v1/services + billing_v1/types diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py new file mode 100644 index 000000000000..7e8c105aacf6 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.billing_v1.services.cloud_billing.client import CloudBillingClient +from google.cloud.billing_v1.services.cloud_billing.async_client import CloudBillingAsyncClient +from google.cloud.billing_v1.services.cloud_catalog.client import CloudCatalogClient +from google.cloud.billing_v1.services.cloud_catalog.async_client import CloudCatalogAsyncClient + +from google.cloud.billing_v1.types.cloud_billing import BillingAccount +from google.cloud.billing_v1.types.cloud_billing import CreateBillingAccountRequest +from google.cloud.billing_v1.types.cloud_billing import GetBillingAccountRequest +from google.cloud.billing_v1.types.cloud_billing import GetProjectBillingInfoRequest +from google.cloud.billing_v1.types.cloud_billing import ListBillingAccountsRequest +from google.cloud.billing_v1.types.cloud_billing import ListBillingAccountsResponse +from google.cloud.billing_v1.types.cloud_billing import ListProjectBillingInfoRequest +from google.cloud.billing_v1.types.cloud_billing import ListProjectBillingInfoResponse +from google.cloud.billing_v1.types.cloud_billing import ProjectBillingInfo +from google.cloud.billing_v1.types.cloud_billing import UpdateBillingAccountRequest +from google.cloud.billing_v1.types.cloud_billing import UpdateProjectBillingInfoRequest +from google.cloud.billing_v1.types.cloud_catalog import AggregationInfo +from google.cloud.billing_v1.types.cloud_catalog import Category +from google.cloud.billing_v1.types.cloud_catalog import GeoTaxonomy +from google.cloud.billing_v1.types.cloud_catalog import ListServicesRequest +from google.cloud.billing_v1.types.cloud_catalog import ListServicesResponse +from google.cloud.billing_v1.types.cloud_catalog import ListSkusRequest +from google.cloud.billing_v1.types.cloud_catalog import ListSkusResponse +from google.cloud.billing_v1.types.cloud_catalog import PricingExpression +from google.cloud.billing_v1.types.cloud_catalog import PricingInfo +from google.cloud.billing_v1.types.cloud_catalog import Service +from google.cloud.billing_v1.types.cloud_catalog import Sku + +__all__ = ('CloudBillingClient', + 'CloudBillingAsyncClient', + 'CloudCatalogClient', + 'CloudCatalogAsyncClient', + 'BillingAccount', + 'CreateBillingAccountRequest', + 'GetBillingAccountRequest', + 'GetProjectBillingInfoRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'ProjectBillingInfo', + 'UpdateBillingAccountRequest', + 'UpdateProjectBillingInfoRequest', + 'AggregationInfo', + 'Category', + 'GeoTaxonomy', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + 'PricingExpression', + 'PricingInfo', + 'Service', + 'Sku', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py new file mode 100644 index 000000000000..405b1cebcf15 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/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/google-cloud-billing/v1/google/cloud/billing/py.typed b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed new file mode 100644 index 000000000000..5e186150e95f --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-billing package uses inline types. diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py new file mode 100644 index 000000000000..8253e44be786 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.cloud_billing import CloudBillingClient +from .services.cloud_billing import CloudBillingAsyncClient +from .services.cloud_catalog import CloudCatalogClient +from .services.cloud_catalog import CloudCatalogAsyncClient + +from .types.cloud_billing import BillingAccount +from .types.cloud_billing import CreateBillingAccountRequest +from .types.cloud_billing import GetBillingAccountRequest +from .types.cloud_billing import GetProjectBillingInfoRequest +from .types.cloud_billing import ListBillingAccountsRequest +from .types.cloud_billing import ListBillingAccountsResponse +from .types.cloud_billing import ListProjectBillingInfoRequest +from .types.cloud_billing import ListProjectBillingInfoResponse +from .types.cloud_billing import ProjectBillingInfo +from .types.cloud_billing import UpdateBillingAccountRequest +from .types.cloud_billing import UpdateProjectBillingInfoRequest +from .types.cloud_catalog import AggregationInfo +from .types.cloud_catalog import Category +from .types.cloud_catalog import GeoTaxonomy +from .types.cloud_catalog import ListServicesRequest +from .types.cloud_catalog import ListServicesResponse +from .types.cloud_catalog import ListSkusRequest +from .types.cloud_catalog import ListSkusResponse +from .types.cloud_catalog import PricingExpression +from .types.cloud_catalog import PricingInfo +from .types.cloud_catalog import Service +from .types.cloud_catalog import Sku + +__all__ = ( + 'CloudBillingAsyncClient', + 'CloudCatalogAsyncClient', +'AggregationInfo', +'BillingAccount', +'Category', +'CloudBillingClient', +'CloudCatalogClient', +'CreateBillingAccountRequest', +'GeoTaxonomy', +'GetBillingAccountRequest', +'GetProjectBillingInfoRequest', +'ListBillingAccountsRequest', +'ListBillingAccountsResponse', +'ListProjectBillingInfoRequest', +'ListProjectBillingInfoResponse', +'ListServicesRequest', +'ListServicesResponse', +'ListSkusRequest', +'ListSkusResponse', +'PricingExpression', +'PricingInfo', +'ProjectBillingInfo', +'Service', +'Sku', +'UpdateBillingAccountRequest', +'UpdateProjectBillingInfoRequest', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json new file mode 100644 index 000000000000..d7464c62897f --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json @@ -0,0 +1,227 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.billing_v1", + "protoPackage": "google.cloud.billing.v1", + "schema": "1.0", + "services": { + "CloudBilling": { + "clients": { + "grpc": { + "libraryClient": "CloudBillingClient", + "rpcs": { + "CreateBillingAccount": { + "methods": [ + "create_billing_account" + ] + }, + "GetBillingAccount": { + "methods": [ + "get_billing_account" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetProjectBillingInfo": { + "methods": [ + "get_project_billing_info" + ] + }, + "ListBillingAccounts": { + "methods": [ + "list_billing_accounts" + ] + }, + "ListProjectBillingInfo": { + "methods": [ + "list_project_billing_info" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateBillingAccount": { + "methods": [ + "update_billing_account" + ] + }, + "UpdateProjectBillingInfo": { + "methods": [ + "update_project_billing_info" + ] + } + } + }, + "grpc-async": { + "libraryClient": "CloudBillingAsyncClient", + "rpcs": { + "CreateBillingAccount": { + "methods": [ + "create_billing_account" + ] + }, + "GetBillingAccount": { + "methods": [ + "get_billing_account" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetProjectBillingInfo": { + "methods": [ + "get_project_billing_info" + ] + }, + "ListBillingAccounts": { + "methods": [ + "list_billing_accounts" + ] + }, + "ListProjectBillingInfo": { + "methods": [ + "list_project_billing_info" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateBillingAccount": { + "methods": [ + "update_billing_account" + ] + }, + "UpdateProjectBillingInfo": { + "methods": [ + "update_project_billing_info" + ] + } + } + }, + "rest": { + "libraryClient": "CloudBillingClient", + "rpcs": { + "CreateBillingAccount": { + "methods": [ + "create_billing_account" + ] + }, + "GetBillingAccount": { + "methods": [ + "get_billing_account" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetProjectBillingInfo": { + "methods": [ + "get_project_billing_info" + ] + }, + "ListBillingAccounts": { + "methods": [ + "list_billing_accounts" + ] + }, + "ListProjectBillingInfo": { + "methods": [ + "list_project_billing_info" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateBillingAccount": { + "methods": [ + "update_billing_account" + ] + }, + "UpdateProjectBillingInfo": { + "methods": [ + "update_project_billing_info" + ] + } + } + } + } + }, + "CloudCatalog": { + "clients": { + "grpc": { + "libraryClient": "CloudCatalogClient", + "rpcs": { + "ListServices": { + "methods": [ + "list_services" + ] + }, + "ListSkus": { + "methods": [ + "list_skus" + ] + } + } + }, + "grpc-async": { + "libraryClient": "CloudCatalogAsyncClient", + "rpcs": { + "ListServices": { + "methods": [ + "list_services" + ] + }, + "ListSkus": { + "methods": [ + "list_skus" + ] + } + } + }, + "rest": { + "libraryClient": "CloudCatalogClient", + "rpcs": { + "ListServices": { + "methods": [ + "list_services" + ] + }, + "ListSkus": { + "methods": [ + "list_skus" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py new file mode 100644 index 000000000000..405b1cebcf15 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_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/google-cloud-billing/v1/google/cloud/billing_v1/py.typed b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed new file mode 100644 index 000000000000..5e186150e95f --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-billing package uses inline types. diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py new file mode 100644 index 000000000000..e8e1c3845db5 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_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/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py new file mode 100644 index 000000000000..23604d7beb4a --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__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 CloudBillingClient +from .async_client import CloudBillingAsyncClient + +__all__ = ( + 'CloudBillingClient', + 'CloudBillingAsyncClient', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py new file mode 100644 index 000000000000..5d40efc79657 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py @@ -0,0 +1,1508 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_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.cloud.billing_v1.services.cloud_billing import pagers +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport +from .client import CloudBillingClient + + +class CloudBillingAsyncClient: + """Retrieves the Google Cloud Console billing accounts and + associates them with projects. + """ + + _client: CloudBillingClient + + DEFAULT_ENDPOINT = CloudBillingClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = CloudBillingClient.DEFAULT_MTLS_ENDPOINT + + project_billing_info_path = staticmethod(CloudBillingClient.project_billing_info_path) + parse_project_billing_info_path = staticmethod(CloudBillingClient.parse_project_billing_info_path) + common_billing_account_path = staticmethod(CloudBillingClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(CloudBillingClient.parse_common_billing_account_path) + common_folder_path = staticmethod(CloudBillingClient.common_folder_path) + parse_common_folder_path = staticmethod(CloudBillingClient.parse_common_folder_path) + common_organization_path = staticmethod(CloudBillingClient.common_organization_path) + parse_common_organization_path = staticmethod(CloudBillingClient.parse_common_organization_path) + common_project_path = staticmethod(CloudBillingClient.common_project_path) + parse_common_project_path = staticmethod(CloudBillingClient.parse_common_project_path) + common_location_path = staticmethod(CloudBillingClient.common_location_path) + parse_common_location_path = staticmethod(CloudBillingClient.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: + CloudBillingAsyncClient: The constructed client. + """ + return CloudBillingClient.from_service_account_info.__func__(CloudBillingAsyncClient, 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: + CloudBillingAsyncClient: The constructed client. + """ + return CloudBillingClient.from_service_account_file.__func__(CloudBillingAsyncClient, 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 CloudBillingClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> CloudBillingTransport: + """Returns the transport used by the client instance. + + Returns: + CloudBillingTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(CloudBillingClient).get_transport_class, type(CloudBillingClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, CloudBillingTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud billing 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, ~.CloudBillingTransport]): 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 = CloudBillingClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def get_billing_account(self, + request: Optional[Union[cloud_billing.GetBillingAccountRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Gets information about a billing account. The current + authenticated user must be a `viewer of the billing + account `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_get_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.GetBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = await client.get_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.GetBillingAccountRequest, dict]]): + The request object. Request message for ``GetBillingAccount``. + name (:class:`str`): + Required. The resource name of the billing account to + retrieve. For example, + ``billingAccounts/012345-567890-ABCDEF``. + + 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.GetBillingAccountRequest(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_billing_account, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_billing_accounts(self, + request: Optional[Union[cloud_billing.ListBillingAccountsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListBillingAccountsAsyncPager: + r"""Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_list_billing_accounts(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListBillingAccountsRequest( + ) + + # Make the request + page_result = client.list_billing_accounts(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.ListBillingAccountsRequest, dict]]): + The request object. Request message for ``ListBillingAccounts``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager: + Response message for ListBillingAccounts. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + request = cloud_billing.ListBillingAccountsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_billing_accounts, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # 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.ListBillingAccountsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_billing_account(self, + request: Optional[Union[cloud_billing.UpdateBillingAccountRequest, dict]] = None, + *, + name: Optional[str] = None, + account: Optional[cloud_billing.BillingAccount] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Updates a billing account's fields. Currently the only field + that can be edited is ``display_name``. The current + authenticated user must have the ``billing.accounts.update`` IAM + permission, which is typically given to the + `administrator `__ + of the billing account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_update_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.UpdateBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = await client.update_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.UpdateBillingAccountRequest, dict]]): + The request object. Request message for ``UpdateBillingAccount``. + name (:class:`str`): + Required. The name of the billing + account resource to be updated. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + account (:class:`google.cloud.billing_v1.types.BillingAccount`): + Required. The billing account + resource to replace the resource on the + server. + + This corresponds to the ``account`` 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a 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, account]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.UpdateBillingAccountRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if account is not None: + request.account = account + + # 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_billing_account, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_billing_account(self, + request: Optional[Union[cloud_billing.CreateBillingAccountRequest, dict]] = None, + *, + billing_account: Optional[cloud_billing.BillingAccount] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""This method creates `billing + subaccounts `__. + + Google Cloud resellers should use the Channel Services APIs, + `accounts.customers.create `__ + and + `accounts.customers.entitlements.create `__. + + When creating a subaccount, the current authenticated user must + have the ``billing.accounts.update`` IAM permission on the + parent account, which is typically given to billing account + `administrators `__. + This method will return an error if the parent account has not + been provisioned as a reseller account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_create_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.CreateBillingAccountRequest( + ) + + # Make the request + response = await client.create_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.CreateBillingAccountRequest, dict]]): + The request object. Request message for ``CreateBillingAccount``. + billing_account (:class:`google.cloud.billing_v1.types.BillingAccount`): + Required. The billing account + resource to create. Currently + CreateBillingAccount only supports + subaccount creation, so any created + billing accounts must be under a + provided parent billing account. + + This corresponds to the ``billing_account`` 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a 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([billing_account]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.CreateBillingAccountRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if billing_account is not None: + request.billing_account = billing_account + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_billing_account, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_project_billing_info(self, + request: Optional[Union[cloud_billing.ListProjectBillingInfoRequest, 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]] = (), + ) -> pagers.ListProjectBillingInfoAsyncPager: + r"""Lists the projects associated with a billing account. The + current authenticated user must have the + ``billing.resourceAssociations.list`` IAM permission, which is + often given to billing account + `viewers `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_list_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + page_result = client.list_project_billing_info(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.ListProjectBillingInfoRequest, dict]]): + The request object. Request message for ``ListProjectBillingInfo``. + name (:class:`str`): + Required. The resource name of the billing account + associated with the projects that you want to list. For + example, ``billingAccounts/012345-567890-ABCDEF``. + + 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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager: + Request message for ListProjectBillingInfoResponse. + + 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([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.ListProjectBillingInfoRequest(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.list_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListProjectBillingInfoAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_project_billing_info(self, + request: Optional[Union[cloud_billing.GetProjectBillingInfoRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Gets the billing information for a project. The current + authenticated user must have the + ``resourcemanager.projects.get`` permission for the project, + which can be granted by assigning the `Project + Viewer `__ + role. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_get_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.GetProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.get_project_billing_info(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.GetProjectBillingInfoRequest, dict]]): + The request object. Request message for ``GetProjectBillingInfo``. + name (:class:`str`): + Required. The resource name of the project for which + billing information is retrieved. For example, + ``projects/tokyo-rain-123``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.billing_v1.types.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.GetProjectBillingInfoRequest(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_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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_project_billing_info(self, + request: Optional[Union[cloud_billing.UpdateProjectBillingInfoRequest, dict]] = None, + *, + name: Optional[str] = None, + project_billing_info: Optional[cloud_billing.ProjectBillingInfo] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Sets or updates the billing account associated with a project. + You specify the new billing account by setting the + ``billing_account_name`` in the ``ProjectBillingInfo`` resource + to the resource name of a billing account. Associating a project + with an open billing account enables billing on the project and + allows charges for resource usage. If the project already had a + billing account, this method changes the billing account used + for resource usage charges. + + *Note:* Incurred charges that have not yet been reported in the + transaction history of the Google Cloud Console might be billed + to the new billing account, even if the charge occurred before + the new billing account was assigned to the project. + + The current authenticated user must have ownership privileges + for both the + `project `__ + and the `billing + account `__. + + You can disable billing on the project by setting the + ``billing_account_name`` field to empty. This action + disassociates the current billing account from the project. Any + billable activity of your in-use services will stop, and your + application could stop functioning as expected. Any unbilled + charges to date will be billed to the previously associated + account. The current authenticated user must be either an owner + of the project or an owner of the billing account for the + project. + + Note that associating a project with a *closed* billing account + will have much the same effect as disabling billing on the + project: any paid resources used by the project will be shut + down. Thus, unless you wish to disable billing, you should + always call this method with the name of an *open* billing + account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_update_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.UpdateProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.update_project_billing_info(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest, dict]]): + The request object. Request message for ``UpdateProjectBillingInfo``. + name (:class:`str`): + Required. The resource name of the project associated + with the billing information that you want to update. + For example, ``projects/tokyo-rain-123``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + project_billing_info (:class:`google.cloud.billing_v1.types.ProjectBillingInfo`): + The new billing information for the project. Read-only + fields are ignored; thus, you can leave empty all fields + except ``billing_account_name``. + + This corresponds to the ``project_billing_info`` 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.billing_v1.types.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + # Create or coerce a 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, project_billing_info]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_billing.UpdateProjectBillingInfoRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if project_billing_info is not None: + request.project_billing_info = project_billing_info + + # 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_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_iam_policy(self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a billing account. The caller + must have the ``billing.accounts.getIamPolicy`` permission on + the account, which is often given to billing account + `viewers `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_get_iam_policy(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]): + The request object. Request message for ``GetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": [ "user:eve@example.com" ], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ], "etag": "BwWWja0YfJA=", "version": 3 + + } + + **YAML example:** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 + + For a description of IAM and its features, see the + [IAM + documentation](\ https://cloud.google.com/iam/docs/). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([resource]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.GetIamPolicyRequest(resource=resource, ) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_iam_policy, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def set_iam_policy(self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Sets the access control policy for a billing account. Replaces + any existing policy. The caller must have the + ``billing.accounts.setIamPolicy`` permission on the account, + which is often given to billing account + `administrators `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_set_iam_policy(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]): + The request object. Request message for ``SetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": [ "user:eve@example.com" ], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ], "etag": "BwWWja0YfJA=", "version": 3 + + } + + **YAML example:** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 + + For a description of IAM and its features, see the + [IAM + documentation](\ https://cloud.google.com/iam/docs/). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([resource]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.SetIamPolicyRequest(resource=resource, ) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.set_iam_policy, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def test_iam_permissions(self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + resource: Optional[str] = None, + permissions: Optional[MutableSequence[str]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Tests the access control policy for a billing + account. This method takes the resource and a set of + permissions as input and returns the subset of the input + permissions that the caller is allowed for that + 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 billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_test_iam_permissions(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = await client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]): + The request object. Request message for ``TestIamPermissions`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy detail is being requested. See + the operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + permissions (:class:`MutableSequence[str]`): + The set of permissions to check for the ``resource``. + Permissions with wildcards (such as '*' or 'storage.*') + are not allowed. For more information see `IAM + Overview `__. + + This corresponds to the ``permissions`` 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.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions 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([resource, permissions]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + request = iam_policy_pb2.TestIamPermissionsRequest(resource=resource, permissions=permissions, ) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.test_iam_permissions, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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(( + ("resource", request.resource), + )), + ) + + # 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__ = ( + "CloudBillingAsyncClient", +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py new file mode 100644 index 000000000000..b3b667df034d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py @@ -0,0 +1,1649 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_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.cloud.billing_v1.services.cloud_billing import pagers +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import CloudBillingGrpcTransport +from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport +from .transports.rest import CloudBillingRestTransport + + +class CloudBillingClientMeta(type): + """Metaclass for the CloudBilling 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[CloudBillingTransport]] + _transport_registry["grpc"] = CloudBillingGrpcTransport + _transport_registry["grpc_asyncio"] = CloudBillingGrpcAsyncIOTransport + _transport_registry["rest"] = CloudBillingRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[CloudBillingTransport]: + """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 CloudBillingClient(metaclass=CloudBillingClientMeta): + """Retrieves the Google Cloud Console billing accounts and + associates them with projects. + """ + + @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 = "cloudbilling.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: + CloudBillingClient: 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: + CloudBillingClient: 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) -> CloudBillingTransport: + """Returns the transport used by the client instance. + + Returns: + CloudBillingTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def project_billing_info_path(project: str,) -> str: + """Returns a fully-qualified project_billing_info string.""" + return "projects/{project}/billingInfo".format(project=project, ) + + @staticmethod + def parse_project_billing_info_path(path: str) -> Dict[str,str]: + """Parses a project_billing_info path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/billingInfo$", 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, CloudBillingTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud billing 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, CloudBillingTransport]): 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, CloudBillingTransport): + # transport is a CloudBillingTransport 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 get_billing_account(self, + request: Optional[Union[cloud_billing.GetBillingAccountRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Gets information about a billing account. The current + authenticated user must be a `viewer of the billing + account `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_get_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.GetBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = client.get_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.GetBillingAccountRequest, dict]): + The request object. Request message for ``GetBillingAccount``. + name (str): + Required. The resource name of the billing account to + retrieve. For example, + ``billingAccounts/012345-567890-ABCDEF``. + + 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.GetBillingAccountRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.GetBillingAccountRequest): + request = cloud_billing.GetBillingAccountRequest(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_billing_account] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_billing_accounts(self, + request: Optional[Union[cloud_billing.ListBillingAccountsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListBillingAccountsPager: + r"""Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_list_billing_accounts(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.ListBillingAccountsRequest( + ) + + # Make the request + page_result = client.list_billing_accounts(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.ListBillingAccountsRequest, dict]): + The request object. Request message for ``ListBillingAccounts``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager: + Response message for ListBillingAccounts. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.ListBillingAccountsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.ListBillingAccountsRequest): + request = cloud_billing.ListBillingAccountsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_billing_accounts] + + # 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.ListBillingAccountsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_billing_account(self, + request: Optional[Union[cloud_billing.UpdateBillingAccountRequest, dict]] = None, + *, + name: Optional[str] = None, + account: Optional[cloud_billing.BillingAccount] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Updates a billing account's fields. Currently the only field + that can be edited is ``display_name``. The current + authenticated user must have the ``billing.accounts.update`` IAM + permission, which is typically given to the + `administrator `__ + of the billing account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_update_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.UpdateBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = client.update_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.UpdateBillingAccountRequest, dict]): + The request object. Request message for ``UpdateBillingAccount``. + name (str): + Required. The name of the billing + account resource to be updated. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + account (google.cloud.billing_v1.types.BillingAccount): + Required. The billing account + resource to replace the resource on the + server. + + This corresponds to the ``account`` 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a 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, account]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.UpdateBillingAccountRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.UpdateBillingAccountRequest): + request = cloud_billing.UpdateBillingAccountRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if account is not None: + request.account = account + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_billing_account] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_billing_account(self, + request: Optional[Union[cloud_billing.CreateBillingAccountRequest, dict]] = None, + *, + billing_account: Optional[cloud_billing.BillingAccount] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""This method creates `billing + subaccounts `__. + + Google Cloud resellers should use the Channel Services APIs, + `accounts.customers.create `__ + and + `accounts.customers.entitlements.create `__. + + When creating a subaccount, the current authenticated user must + have the ``billing.accounts.update`` IAM permission on the + parent account, which is typically given to billing account + `administrators `__. + This method will return an error if the parent account has not + been provisioned as a reseller account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_create_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.CreateBillingAccountRequest( + ) + + # Make the request + response = client.create_billing_account(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.CreateBillingAccountRequest, dict]): + The request object. Request message for ``CreateBillingAccount``. + billing_account (google.cloud.billing_v1.types.BillingAccount): + Required. The billing account + resource to create. Currently + CreateBillingAccount only supports + subaccount creation, so any created + billing accounts must be under a + provided parent billing account. + + This corresponds to the ``billing_account`` 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.billing_v1.types.BillingAccount: + A billing account in the + [Google Cloud + Console](\ https://console.cloud.google.com/). You + can assign a billing account to one or more projects. + + """ + # Create or coerce a 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([billing_account]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.CreateBillingAccountRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.CreateBillingAccountRequest): + request = cloud_billing.CreateBillingAccountRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if billing_account is not None: + request.billing_account = billing_account + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_billing_account] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_project_billing_info(self, + request: Optional[Union[cloud_billing.ListProjectBillingInfoRequest, 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]] = (), + ) -> pagers.ListProjectBillingInfoPager: + r"""Lists the projects associated with a billing account. The + current authenticated user must have the + ``billing.resourceAssociations.list`` IAM permission, which is + often given to billing account + `viewers `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_list_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.ListProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + page_result = client.list_project_billing_info(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.ListProjectBillingInfoRequest, dict]): + The request object. Request message for ``ListProjectBillingInfo``. + name (str): + Required. The resource name of the billing account + associated with the projects that you want to list. For + example, ``billingAccounts/012345-567890-ABCDEF``. + + 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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager: + Request message for ListProjectBillingInfoResponse. + + 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([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.ListProjectBillingInfoRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.ListProjectBillingInfoRequest): + request = cloud_billing.ListProjectBillingInfoRequest(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.list_project_billing_info] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListProjectBillingInfoPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_project_billing_info(self, + request: Optional[Union[cloud_billing.GetProjectBillingInfoRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Gets the billing information for a project. The current + authenticated user must have the + ``resourcemanager.projects.get`` permission for the project, + which can be granted by assigning the `Project + Viewer `__ + role. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_get_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.GetProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = client.get_project_billing_info(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.GetProjectBillingInfoRequest, dict]): + The request object. Request message for ``GetProjectBillingInfo``. + name (str): + Required. The resource name of the project for which + billing information is retrieved. For example, + ``projects/tokyo-rain-123``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.billing_v1.types.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.GetProjectBillingInfoRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.GetProjectBillingInfoRequest): + request = cloud_billing.GetProjectBillingInfoRequest(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_project_billing_info] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_project_billing_info(self, + request: Optional[Union[cloud_billing.UpdateProjectBillingInfoRequest, dict]] = None, + *, + name: Optional[str] = None, + project_billing_info: Optional[cloud_billing.ProjectBillingInfo] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Sets or updates the billing account associated with a project. + You specify the new billing account by setting the + ``billing_account_name`` in the ``ProjectBillingInfo`` resource + to the resource name of a billing account. Associating a project + with an open billing account enables billing on the project and + allows charges for resource usage. If the project already had a + billing account, this method changes the billing account used + for resource usage charges. + + *Note:* Incurred charges that have not yet been reported in the + transaction history of the Google Cloud Console might be billed + to the new billing account, even if the charge occurred before + the new billing account was assigned to the project. + + The current authenticated user must have ownership privileges + for both the + `project `__ + and the `billing + account `__. + + You can disable billing on the project by setting the + ``billing_account_name`` field to empty. This action + disassociates the current billing account from the project. Any + billable activity of your in-use services will stop, and your + application could stop functioning as expected. Any unbilled + charges to date will be billed to the previously associated + account. The current authenticated user must be either an owner + of the project or an owner of the billing account for the + project. + + Note that associating a project with a *closed* billing account + will have much the same effect as disabling billing on the + project: any paid resources used by the project will be shut + down. Thus, unless you wish to disable billing, you should + always call this method with the name of an *open* billing + account. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_update_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.UpdateProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = client.update_project_billing_info(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest, dict]): + The request object. Request message for ``UpdateProjectBillingInfo``. + name (str): + Required. The resource name of the project associated + with the billing information that you want to update. + For example, ``projects/tokyo-rain-123``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + project_billing_info (google.cloud.billing_v1.types.ProjectBillingInfo): + The new billing information for the project. Read-only + fields are ignored; thus, you can leave empty all fields + except ``billing_account_name``. + + This corresponds to the ``project_billing_info`` 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.billing_v1.types.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + # Create or coerce a 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, project_billing_info]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_billing.UpdateProjectBillingInfoRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_billing.UpdateProjectBillingInfoRequest): + request = cloud_billing.UpdateProjectBillingInfoRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if project_billing_info is not None: + request.project_billing_info = project_billing_info + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_project_billing_info] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_iam_policy(self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a billing account. The caller + must have the ``billing.accounts.getIamPolicy`` permission on + the account, which is often given to billing account + `viewers `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_get_iam_policy(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): + The request object. Request message for ``GetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": [ "user:eve@example.com" ], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ], "etag": "BwWWja0YfJA=", "version": 3 + + } + + **YAML example:** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 + + For a description of IAM and its features, see the + [IAM + documentation](\ https://cloud.google.com/iam/docs/). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([resource]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.GetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def set_iam_policy(self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Sets the access control policy for a billing account. Replaces + any existing policy. The caller must have the + ``billing.accounts.setIamPolicy`` permission on the account, + which is often given to billing account + `administrators `__. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_set_iam_policy(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): + The request object. Request message for ``SetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + { + "bindings": [ + { + "role": + "roles/resourcemanager.organizationAdmin", + "members": [ "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + + }, { "role": + "roles/resourcemanager.organizationViewer", + "members": [ "user:eve@example.com" ], + "condition": { "title": "expirable access", + "description": "Does not grant access after + Sep 2020", "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", } } + + ], "etag": "BwWWja0YfJA=", "version": 3 + + } + + **YAML example:** + + bindings: - members: - user:\ mike@example.com - + group:\ admins@example.com - domain:google.com - + serviceAccount:\ my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin - + members: - user:\ eve@example.com role: + roles/resourcemanager.organizationViewer + condition: title: expirable access description: + Does not grant access after Sep 2020 expression: + request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 + + For a description of IAM and its features, see the + [IAM + documentation](\ https://cloud.google.com/iam/docs/). + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([resource]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.SetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def test_iam_permissions(self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + resource: Optional[str] = None, + permissions: Optional[MutableSequence[str]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Tests the access control policy for a billing + account. This method takes the resource and a set of + permissions as input and returns the subset of the input + permissions that the caller is allowed for that + 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 billing_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_test_iam_permissions(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): + The request object. Request message for ``TestIamPermissions`` method. + resource (str): + REQUIRED: The resource for which the + policy detail is being requested. See + the operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + permissions (MutableSequence[str]): + The set of permissions to check for the ``resource``. + Permissions with wildcards (such as '*' or 'storage.*') + are not allowed. For more information see `IAM + Overview `__. + + This corresponds to the ``permissions`` 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.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions 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([resource, permissions]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + if isinstance(request, dict): + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.TestIamPermissionsRequest() + if resource is not None: + request.resource = resource + if permissions: + request.permissions.extend(permissions) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "CloudBillingClient": + 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__ = ( + "CloudBillingClient", +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py new file mode 100644 index 000000000000..62cee567d28b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_v1.types import cloud_billing + + +class ListBillingAccountsPager: + """A pager for iterating through ``list_billing_accounts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``billing_accounts`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListBillingAccounts`` requests and continue to iterate + through the ``billing_accounts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_billing.ListBillingAccountsResponse], + request: cloud_billing.ListBillingAccountsRequest, + response: cloud_billing.ListBillingAccountsResponse, + *, + 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.billing_v1.types.ListBillingAccountsRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListBillingAccountsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_billing.ListBillingAccountsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_billing.ListBillingAccountsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_billing.BillingAccount]: + for page in self.pages: + yield from page.billing_accounts + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListBillingAccountsAsyncPager: + """A pager for iterating through ``list_billing_accounts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``billing_accounts`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListBillingAccounts`` requests and continue to iterate + through the ``billing_accounts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_billing.ListBillingAccountsResponse]], + request: cloud_billing.ListBillingAccountsRequest, + response: cloud_billing.ListBillingAccountsResponse, + *, + 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.billing_v1.types.ListBillingAccountsRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListBillingAccountsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_billing.ListBillingAccountsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_billing.ListBillingAccountsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_billing.BillingAccount]: + async def async_generator(): + async for page in self.pages: + for response in page.billing_accounts: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListProjectBillingInfoPager: + """A pager for iterating through ``list_project_billing_info`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` object, and + provides an ``__iter__`` method to iterate through its + ``project_billing_info`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListProjectBillingInfo`` requests and continue to iterate + through the ``project_billing_info`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_billing.ListProjectBillingInfoResponse], + request: cloud_billing.ListProjectBillingInfoRequest, + response: cloud_billing.ListProjectBillingInfoResponse, + *, + 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.billing_v1.types.ListProjectBillingInfoRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_billing.ListProjectBillingInfoRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_billing.ListProjectBillingInfoResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_billing.ProjectBillingInfo]: + for page in self.pages: + yield from page.project_billing_info + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListProjectBillingInfoAsyncPager: + """A pager for iterating through ``list_project_billing_info`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``project_billing_info`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListProjectBillingInfo`` requests and continue to iterate + through the ``project_billing_info`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_billing.ListProjectBillingInfoResponse]], + request: cloud_billing.ListProjectBillingInfoRequest, + response: cloud_billing.ListProjectBillingInfoResponse, + *, + 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.billing_v1.types.ListProjectBillingInfoRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_billing.ListProjectBillingInfoRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_billing.ListProjectBillingInfoResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_billing.ProjectBillingInfo]: + async def async_generator(): + async for page in self.pages: + for response in page.project_billing_info: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py new file mode 100644 index 000000000000..b43a0b23a2ae --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/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 CloudBillingTransport +from .grpc import CloudBillingGrpcTransport +from .grpc_asyncio import CloudBillingGrpcAsyncIOTransport +from .rest import CloudBillingRestTransport +from .rest import CloudBillingRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[CloudBillingTransport]] +_transport_registry['grpc'] = CloudBillingGrpcTransport +_transport_registry['grpc_asyncio'] = CloudBillingGrpcAsyncIOTransport +_transport_registry['rest'] = CloudBillingRestTransport + +__all__ = ( + 'CloudBillingTransport', + 'CloudBillingGrpcTransport', + 'CloudBillingGrpcAsyncIOTransport', + 'CloudBillingRestTransport', + 'CloudBillingRestInterceptor', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py new file mode 100644 index 000000000000..657c5f78e59e --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py @@ -0,0 +1,341 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class CloudBillingTransport(abc.ABC): + """Abstract transport class for CloudBilling.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'cloudbilling.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.get_billing_account: gapic_v1.method.wrap_method( + self.get_billing_account, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_billing_accounts: gapic_v1.method.wrap_method( + self.list_billing_accounts, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_billing_account: gapic_v1.method.wrap_method( + self.update_billing_account, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.create_billing_account: gapic_v1.method.wrap_method( + self.create_billing_account, + default_timeout=60.0, + client_info=client_info, + ), + self.list_project_billing_info: gapic_v1.method.wrap_method( + self.list_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_project_billing_info: gapic_v1.method.wrap_method( + self.get_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_project_billing_info: gapic_v1.method.wrap_method( + self.update_project_billing_info, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_iam_policy: gapic_v1.method.wrap_method( + self.get_iam_policy, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.set_iam_policy: gapic_v1.method.wrap_method( + self.set_iam_policy, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.test_iam_permissions: gapic_v1.method.wrap_method( + self.test_iam_permissions, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + 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 get_billing_account(self) -> Callable[ + [cloud_billing.GetBillingAccountRequest], + Union[ + cloud_billing.BillingAccount, + Awaitable[cloud_billing.BillingAccount] + ]]: + raise NotImplementedError() + + @property + def list_billing_accounts(self) -> Callable[ + [cloud_billing.ListBillingAccountsRequest], + Union[ + cloud_billing.ListBillingAccountsResponse, + Awaitable[cloud_billing.ListBillingAccountsResponse] + ]]: + raise NotImplementedError() + + @property + def update_billing_account(self) -> Callable[ + [cloud_billing.UpdateBillingAccountRequest], + Union[ + cloud_billing.BillingAccount, + Awaitable[cloud_billing.BillingAccount] + ]]: + raise NotImplementedError() + + @property + def create_billing_account(self) -> Callable[ + [cloud_billing.CreateBillingAccountRequest], + Union[ + cloud_billing.BillingAccount, + Awaitable[cloud_billing.BillingAccount] + ]]: + raise NotImplementedError() + + @property + def list_project_billing_info(self) -> Callable[ + [cloud_billing.ListProjectBillingInfoRequest], + Union[ + cloud_billing.ListProjectBillingInfoResponse, + Awaitable[cloud_billing.ListProjectBillingInfoResponse] + ]]: + raise NotImplementedError() + + @property + def get_project_billing_info(self) -> Callable[ + [cloud_billing.GetProjectBillingInfoRequest], + Union[ + cloud_billing.ProjectBillingInfo, + Awaitable[cloud_billing.ProjectBillingInfo] + ]]: + raise NotImplementedError() + + @property + def update_project_billing_info(self) -> Callable[ + [cloud_billing.UpdateProjectBillingInfoRequest], + Union[ + cloud_billing.ProjectBillingInfo, + Awaitable[cloud_billing.ProjectBillingInfo] + ]]: + raise NotImplementedError() + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Union[ + iam_policy_pb2.TestIamPermissionsResponse, + Awaitable[iam_policy_pb2.TestIamPermissionsResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'CloudBillingTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py new file mode 100644 index 000000000000..f9cdc426798c --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py @@ -0,0 +1,578 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 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.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO + + +class CloudBillingGrpcTransport(CloudBillingTransport): + """gRPC backend transport for CloudBilling. + + Retrieves the Google Cloud Console billing accounts and + associates them with projects. + + 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 = 'cloudbilling.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] = {} + + 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 = 'cloudbilling.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 get_billing_account(self) -> Callable[ + [cloud_billing.GetBillingAccountRequest], + cloud_billing.BillingAccount]: + r"""Return a callable for the get billing account method over gRPC. + + Gets information about a billing account. The current + authenticated user must be a `viewer of the billing + account `__. + + Returns: + Callable[[~.GetBillingAccountRequest], + ~.BillingAccount]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_account' not in self._stubs: + self._stubs['get_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetBillingAccount', + request_serializer=cloud_billing.GetBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['get_billing_account'] + + @property + def list_billing_accounts(self) -> Callable[ + [cloud_billing.ListBillingAccountsRequest], + cloud_billing.ListBillingAccountsResponse]: + r"""Return a callable for the list billing accounts method over gRPC. + + Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + Returns: + Callable[[~.ListBillingAccountsRequest], + ~.ListBillingAccountsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_accounts' not in self._stubs: + self._stubs['list_billing_accounts'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/ListBillingAccounts', + request_serializer=cloud_billing.ListBillingAccountsRequest.serialize, + response_deserializer=cloud_billing.ListBillingAccountsResponse.deserialize, + ) + return self._stubs['list_billing_accounts'] + + @property + def update_billing_account(self) -> Callable[ + [cloud_billing.UpdateBillingAccountRequest], + cloud_billing.BillingAccount]: + r"""Return a callable for the update billing account method over gRPC. + + Updates a billing account's fields. Currently the only field + that can be edited is ``display_name``. The current + authenticated user must have the ``billing.accounts.update`` IAM + permission, which is typically given to the + `administrator `__ + of the billing account. + + Returns: + Callable[[~.UpdateBillingAccountRequest], + ~.BillingAccount]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_account' not in self._stubs: + self._stubs['update_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/UpdateBillingAccount', + request_serializer=cloud_billing.UpdateBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['update_billing_account'] + + @property + def create_billing_account(self) -> Callable[ + [cloud_billing.CreateBillingAccountRequest], + cloud_billing.BillingAccount]: + r"""Return a callable for the create billing account method over gRPC. + + This method creates `billing + subaccounts `__. + + Google Cloud resellers should use the Channel Services APIs, + `accounts.customers.create `__ + and + `accounts.customers.entitlements.create `__. + + When creating a subaccount, the current authenticated user must + have the ``billing.accounts.update`` IAM permission on the + parent account, which is typically given to billing account + `administrators `__. + This method will return an error if the parent account has not + been provisioned as a reseller account. + + Returns: + Callable[[~.CreateBillingAccountRequest], + ~.BillingAccount]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_billing_account' not in self._stubs: + self._stubs['create_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/CreateBillingAccount', + request_serializer=cloud_billing.CreateBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['create_billing_account'] + + @property + def list_project_billing_info(self) -> Callable[ + [cloud_billing.ListProjectBillingInfoRequest], + cloud_billing.ListProjectBillingInfoResponse]: + r"""Return a callable for the list project billing info method over gRPC. + + Lists the projects associated with a billing account. The + current authenticated user must have the + ``billing.resourceAssociations.list`` IAM permission, which is + often given to billing account + `viewers `__. + + Returns: + Callable[[~.ListProjectBillingInfoRequest], + ~.ListProjectBillingInfoResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['list_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/ListProjectBillingInfo', + request_serializer=cloud_billing.ListProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ListProjectBillingInfoResponse.deserialize, + ) + return self._stubs['list_project_billing_info'] + + @property + def get_project_billing_info(self) -> Callable[ + [cloud_billing.GetProjectBillingInfoRequest], + cloud_billing.ProjectBillingInfo]: + r"""Return a callable for the get project billing info method over gRPC. + + Gets the billing information for a project. The current + authenticated user must have the + ``resourcemanager.projects.get`` permission for the project, + which can be granted by assigning the `Project + Viewer `__ + role. + + Returns: + Callable[[~.GetProjectBillingInfoRequest], + ~.ProjectBillingInfo]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['get_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetProjectBillingInfo', + request_serializer=cloud_billing.GetProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, + ) + return self._stubs['get_project_billing_info'] + + @property + def update_project_billing_info(self) -> Callable[ + [cloud_billing.UpdateProjectBillingInfoRequest], + cloud_billing.ProjectBillingInfo]: + r"""Return a callable for the update project billing info method over gRPC. + + Sets or updates the billing account associated with a project. + You specify the new billing account by setting the + ``billing_account_name`` in the ``ProjectBillingInfo`` resource + to the resource name of a billing account. Associating a project + with an open billing account enables billing on the project and + allows charges for resource usage. If the project already had a + billing account, this method changes the billing account used + for resource usage charges. + + *Note:* Incurred charges that have not yet been reported in the + transaction history of the Google Cloud Console might be billed + to the new billing account, even if the charge occurred before + the new billing account was assigned to the project. + + The current authenticated user must have ownership privileges + for both the + `project `__ + and the `billing + account `__. + + You can disable billing on the project by setting the + ``billing_account_name`` field to empty. This action + disassociates the current billing account from the project. Any + billable activity of your in-use services will stop, and your + application could stop functioning as expected. Any unbilled + charges to date will be billed to the previously associated + account. The current authenticated user must be either an owner + of the project or an owner of the billing account for the + project. + + Note that associating a project with a *closed* billing account + will have much the same effect as disabling billing on the + project: any paid resources used by the project will be shut + down. Thus, unless you wish to disable billing, you should + always call this method with the name of an *open* billing + account. + + Returns: + Callable[[~.UpdateProjectBillingInfoRequest], + ~.ProjectBillingInfo]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['update_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/UpdateProjectBillingInfo', + request_serializer=cloud_billing.UpdateProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, + ) + return self._stubs['update_project_billing_info'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a billing account. The caller + must have the ``billing.accounts.getIamPolicy`` permission on + the account, which is often given to billing account + `viewers `__. + + Returns: + Callable[[~.GetIamPolicyRequest], + ~.Policy]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets the access control policy for a billing account. Replaces + any existing policy. The caller must have the + ``billing.accounts.setIamPolicy`` permission on the account, + which is often given to billing account + `administrators `__. + + Returns: + Callable[[~.SetIamPolicyRequest], + ~.Policy]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse]: + r"""Return a callable for the test iam permissions method over gRPC. + + Tests the access control policy for a billing + account. This method takes the resource and a set of + permissions as input and returns the subset of the input + permissions that the caller is allowed for that + resource. + + Returns: + Callable[[~.TestIamPermissionsRequest], + ~.TestIamPermissionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'CloudBillingGrpcTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py new file mode 100644 index 000000000000..cd0e9889c83a --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py @@ -0,0 +1,577 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.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.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .grpc import CloudBillingGrpcTransport + + +class CloudBillingGrpcAsyncIOTransport(CloudBillingTransport): + """gRPC AsyncIO backend transport for CloudBilling. + + Retrieves the Google Cloud Console billing accounts and + associates them with projects. + + 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 = 'cloudbilling.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 = 'cloudbilling.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] = {} + + 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 get_billing_account(self) -> Callable[ + [cloud_billing.GetBillingAccountRequest], + Awaitable[cloud_billing.BillingAccount]]: + r"""Return a callable for the get billing account method over gRPC. + + Gets information about a billing account. The current + authenticated user must be a `viewer of the billing + account `__. + + Returns: + Callable[[~.GetBillingAccountRequest], + Awaitable[~.BillingAccount]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_account' not in self._stubs: + self._stubs['get_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetBillingAccount', + request_serializer=cloud_billing.GetBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['get_billing_account'] + + @property + def list_billing_accounts(self) -> Callable[ + [cloud_billing.ListBillingAccountsRequest], + Awaitable[cloud_billing.ListBillingAccountsResponse]]: + r"""Return a callable for the list billing accounts method over gRPC. + + Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + Returns: + Callable[[~.ListBillingAccountsRequest], + Awaitable[~.ListBillingAccountsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_accounts' not in self._stubs: + self._stubs['list_billing_accounts'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/ListBillingAccounts', + request_serializer=cloud_billing.ListBillingAccountsRequest.serialize, + response_deserializer=cloud_billing.ListBillingAccountsResponse.deserialize, + ) + return self._stubs['list_billing_accounts'] + + @property + def update_billing_account(self) -> Callable[ + [cloud_billing.UpdateBillingAccountRequest], + Awaitable[cloud_billing.BillingAccount]]: + r"""Return a callable for the update billing account method over gRPC. + + Updates a billing account's fields. Currently the only field + that can be edited is ``display_name``. The current + authenticated user must have the ``billing.accounts.update`` IAM + permission, which is typically given to the + `administrator `__ + of the billing account. + + Returns: + Callable[[~.UpdateBillingAccountRequest], + Awaitable[~.BillingAccount]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_billing_account' not in self._stubs: + self._stubs['update_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/UpdateBillingAccount', + request_serializer=cloud_billing.UpdateBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['update_billing_account'] + + @property + def create_billing_account(self) -> Callable[ + [cloud_billing.CreateBillingAccountRequest], + Awaitable[cloud_billing.BillingAccount]]: + r"""Return a callable for the create billing account method over gRPC. + + This method creates `billing + subaccounts `__. + + Google Cloud resellers should use the Channel Services APIs, + `accounts.customers.create `__ + and + `accounts.customers.entitlements.create `__. + + When creating a subaccount, the current authenticated user must + have the ``billing.accounts.update`` IAM permission on the + parent account, which is typically given to billing account + `administrators `__. + This method will return an error if the parent account has not + been provisioned as a reseller account. + + Returns: + Callable[[~.CreateBillingAccountRequest], + Awaitable[~.BillingAccount]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_billing_account' not in self._stubs: + self._stubs['create_billing_account'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/CreateBillingAccount', + request_serializer=cloud_billing.CreateBillingAccountRequest.serialize, + response_deserializer=cloud_billing.BillingAccount.deserialize, + ) + return self._stubs['create_billing_account'] + + @property + def list_project_billing_info(self) -> Callable[ + [cloud_billing.ListProjectBillingInfoRequest], + Awaitable[cloud_billing.ListProjectBillingInfoResponse]]: + r"""Return a callable for the list project billing info method over gRPC. + + Lists the projects associated with a billing account. The + current authenticated user must have the + ``billing.resourceAssociations.list`` IAM permission, which is + often given to billing account + `viewers `__. + + Returns: + Callable[[~.ListProjectBillingInfoRequest], + Awaitable[~.ListProjectBillingInfoResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['list_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/ListProjectBillingInfo', + request_serializer=cloud_billing.ListProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ListProjectBillingInfoResponse.deserialize, + ) + return self._stubs['list_project_billing_info'] + + @property + def get_project_billing_info(self) -> Callable[ + [cloud_billing.GetProjectBillingInfoRequest], + Awaitable[cloud_billing.ProjectBillingInfo]]: + r"""Return a callable for the get project billing info method over gRPC. + + Gets the billing information for a project. The current + authenticated user must have the + ``resourcemanager.projects.get`` permission for the project, + which can be granted by assigning the `Project + Viewer `__ + role. + + Returns: + Callable[[~.GetProjectBillingInfoRequest], + Awaitable[~.ProjectBillingInfo]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['get_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetProjectBillingInfo', + request_serializer=cloud_billing.GetProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, + ) + return self._stubs['get_project_billing_info'] + + @property + def update_project_billing_info(self) -> Callable[ + [cloud_billing.UpdateProjectBillingInfoRequest], + Awaitable[cloud_billing.ProjectBillingInfo]]: + r"""Return a callable for the update project billing info method over gRPC. + + Sets or updates the billing account associated with a project. + You specify the new billing account by setting the + ``billing_account_name`` in the ``ProjectBillingInfo`` resource + to the resource name of a billing account. Associating a project + with an open billing account enables billing on the project and + allows charges for resource usage. If the project already had a + billing account, this method changes the billing account used + for resource usage charges. + + *Note:* Incurred charges that have not yet been reported in the + transaction history of the Google Cloud Console might be billed + to the new billing account, even if the charge occurred before + the new billing account was assigned to the project. + + The current authenticated user must have ownership privileges + for both the + `project `__ + and the `billing + account `__. + + You can disable billing on the project by setting the + ``billing_account_name`` field to empty. This action + disassociates the current billing account from the project. Any + billable activity of your in-use services will stop, and your + application could stop functioning as expected. Any unbilled + charges to date will be billed to the previously associated + account. The current authenticated user must be either an owner + of the project or an owner of the billing account for the + project. + + Note that associating a project with a *closed* billing account + will have much the same effect as disabling billing on the + project: any paid resources used by the project will be shut + down. Thus, unless you wish to disable billing, you should + always call this method with the name of an *open* billing + account. + + Returns: + Callable[[~.UpdateProjectBillingInfoRequest], + Awaitable[~.ProjectBillingInfo]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: + self._stubs['update_project_billing_info'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/UpdateProjectBillingInfo', + request_serializer=cloud_billing.UpdateProjectBillingInfoRequest.serialize, + response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, + ) + return self._stubs['update_project_billing_info'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a billing account. The caller + must have the ``billing.accounts.getIamPolicy`` permission on + the account, which is often given to billing account + `viewers `__. + + Returns: + Callable[[~.GetIamPolicyRequest], + Awaitable[~.Policy]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets the access control policy for a billing account. Replaces + any existing policy. The caller must have the + ``billing.accounts.setIamPolicy`` permission on the account, + which is often given to billing account + `administrators `__. + + Returns: + Callable[[~.SetIamPolicyRequest], + Awaitable[~.Policy]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: + r"""Return a callable for the test iam permissions method over gRPC. + + Tests the access control policy for a billing + account. This method takes the resource and a set of + permissions as input and returns the subset of the input + permissions that the caller is allowed for that + resource. + + Returns: + Callable[[~.TestIamPermissionsRequest], + Awaitable[~.TestIamPermissionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudBilling/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'CloudBillingGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py new file mode 100644 index 000000000000..120ad64b45af --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py @@ -0,0 +1,1490 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 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.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore + +from .base import CloudBillingTransport, 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 CloudBillingRestInterceptor: + """Interceptor for CloudBilling. + + 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 CloudBillingRestTransport. + + .. code-block:: python + class MyCustomCloudBillingInterceptor(CloudBillingRestInterceptor): + def pre_create_billing_account(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_billing_account(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_billing_account(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_billing_account(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_project_billing_info(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_project_billing_info(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_billing_accounts(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_billing_accounts(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_project_billing_info(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_project_billing_info(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_test_iam_permissions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_test_iam_permissions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_billing_account(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_billing_account(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_project_billing_info(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_project_billing_info(self, response): + logging.log(f"Received response: {response}") + return response + + transport = CloudBillingRestTransport(interceptor=MyCustomCloudBillingInterceptor()) + client = CloudBillingClient(transport=transport) + + + """ + def pre_create_billing_account(self, request: cloud_billing.CreateBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.CreateBillingAccountRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_billing_account + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_create_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: + """Post-rpc interceptor for create_billing_account + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_get_billing_account(self, request: cloud_billing.GetBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.GetBillingAccountRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_billing_account + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_get_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: + """Post-rpc interceptor for get_billing_account + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_get_iam_policy(self, request: iam_policy_pb2.GetIamPolicyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_get_project_billing_info(self, request: cloud_billing.GetProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.GetProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_project_billing_info + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_get_project_billing_info(self, response: cloud_billing.ProjectBillingInfo) -> cloud_billing.ProjectBillingInfo: + """Post-rpc interceptor for get_project_billing_info + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_list_billing_accounts(self, request: cloud_billing.ListBillingAccountsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.ListBillingAccountsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_billing_accounts + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_list_billing_accounts(self, response: cloud_billing.ListBillingAccountsResponse) -> cloud_billing.ListBillingAccountsResponse: + """Post-rpc interceptor for list_billing_accounts + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_list_project_billing_info(self, request: cloud_billing.ListProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.ListProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_project_billing_info + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_list_project_billing_info(self, response: cloud_billing.ListProjectBillingInfoResponse) -> cloud_billing.ListProjectBillingInfoResponse: + """Post-rpc interceptor for list_project_billing_info + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_set_iam_policy(self, request: iam_policy_pb2.SetIamPolicyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_test_iam_permissions(self, request: iam_policy_pb2.TestIamPermissionsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_test_iam_permissions(self, response: iam_policy_pb2.TestIamPermissionsResponse) -> iam_policy_pb2.TestIamPermissionsResponse: + """Post-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_update_billing_account(self, request: cloud_billing.UpdateBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.UpdateBillingAccountRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_billing_account + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_update_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: + """Post-rpc interceptor for update_billing_account + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + def pre_update_project_billing_info(self, request: cloud_billing.UpdateProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.UpdateProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_project_billing_info + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudBilling server. + """ + return request, metadata + + def post_update_project_billing_info(self, response: cloud_billing.ProjectBillingInfo) -> cloud_billing.ProjectBillingInfo: + """Post-rpc interceptor for update_project_billing_info + + Override in a subclass to manipulate the response + after it is returned by the CloudBilling server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class CloudBillingRestStub: + _session: AuthorizedSession + _host: str + _interceptor: CloudBillingRestInterceptor + + +class CloudBillingRestTransport(CloudBillingTransport): + """REST backend transport for CloudBilling. + + Retrieves the Google Cloud Console billing accounts and + associates them with projects. + + 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 = 'cloudbilling.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[CloudBillingRestInterceptor] = 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) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or CloudBillingRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateBillingAccount(CloudBillingRestStub): + def __hash__(self): + return hash("CreateBillingAccount") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.CreateBillingAccountRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.BillingAccount: + r"""Call the create billing account method over HTTP. + + Args: + request (~.cloud_billing.CreateBillingAccountRequest): + The request object. Request message for ``CreateBillingAccount``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.BillingAccount: + A billing account in the `Google Cloud + Console `__. You can + assign a billing account to one or more projects. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/billingAccounts', + 'body': 'billing_account', + }, + ] + request, metadata = self._interceptor.pre_create_billing_account(request, metadata) + pb_request = cloud_billing.CreateBillingAccountRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.BillingAccount() + pb_resp = cloud_billing.BillingAccount.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_billing_account(resp) + return resp + + class _GetBillingAccount(CloudBillingRestStub): + def __hash__(self): + return hash("GetBillingAccount") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.GetBillingAccountRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.BillingAccount: + r"""Call the get billing account method over HTTP. + + Args: + request (~.cloud_billing.GetBillingAccountRequest): + The request object. Request message for ``GetBillingAccount``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.BillingAccount: + A billing account in the `Google Cloud + Console `__. You can + assign a billing account to one or more projects. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=billingAccounts/*}', + }, + ] + request, metadata = self._interceptor.pre_get_billing_account(request, metadata) + pb_request = cloud_billing.GetBillingAccountRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.BillingAccount() + pb_resp = cloud_billing.BillingAccount.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_billing_account(resp) + return resp + + class _GetIamPolicy(CloudBillingRestStub): + def __hash__(self): + return hash("GetIamPolicy") + + __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: iam_policy_pb2.GetIamPolicyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> policy_pb2.Policy: + r"""Call the get iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.GetIamPolicyRequest): + The request object. Request message for ``GetIamPolicy`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{resource=billingAccounts/*}:getIamPolicy', + }, + ] + request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) + pb_request = 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_iam_policy(resp) + return resp + + class _GetProjectBillingInfo(CloudBillingRestStub): + def __hash__(self): + return hash("GetProjectBillingInfo") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.GetProjectBillingInfoRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.ProjectBillingInfo: + r"""Call the get project billing info method over HTTP. + + Args: + request (~.cloud_billing.GetProjectBillingInfoRequest): + The request object. Request message for ``GetProjectBillingInfo``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*}/billingInfo', + }, + ] + request, metadata = self._interceptor.pre_get_project_billing_info(request, metadata) + pb_request = cloud_billing.GetProjectBillingInfoRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.ProjectBillingInfo() + pb_resp = cloud_billing.ProjectBillingInfo.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_project_billing_info(resp) + return resp + + class _ListBillingAccounts(CloudBillingRestStub): + def __hash__(self): + return hash("ListBillingAccounts") + + def __call__(self, + request: cloud_billing.ListBillingAccountsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.ListBillingAccountsResponse: + r"""Call the list billing accounts method over HTTP. + + Args: + request (~.cloud_billing.ListBillingAccountsRequest): + The request object. Request message for ``ListBillingAccounts``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.ListBillingAccountsResponse: + Response message for ``ListBillingAccounts``. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/billingAccounts', + }, + ] + request, metadata = self._interceptor.pre_list_billing_accounts(request, metadata) + pb_request = cloud_billing.ListBillingAccountsRequest.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["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.ListBillingAccountsResponse() + pb_resp = cloud_billing.ListBillingAccountsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_billing_accounts(resp) + return resp + + class _ListProjectBillingInfo(CloudBillingRestStub): + def __hash__(self): + return hash("ListProjectBillingInfo") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.ListProjectBillingInfoRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.ListProjectBillingInfoResponse: + r"""Call the list project billing info method over HTTP. + + Args: + request (~.cloud_billing.ListProjectBillingInfoRequest): + The request object. Request message for ``ListProjectBillingInfo``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.ListProjectBillingInfoResponse: + Request message for ``ListProjectBillingInfoResponse``. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=billingAccounts/*}/projects', + }, + ] + request, metadata = self._interceptor.pre_list_project_billing_info(request, metadata) + pb_request = cloud_billing.ListProjectBillingInfoRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.ListProjectBillingInfoResponse() + pb_resp = cloud_billing.ListProjectBillingInfoResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_project_billing_info(resp) + return resp + + class _SetIamPolicy(CloudBillingRestStub): + def __hash__(self): + return hash("SetIamPolicy") + + __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: iam_policy_pb2.SetIamPolicyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> policy_pb2.Policy: + r"""Call the set iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.SetIamPolicyRequest): + The request object. Request message for ``SetIamPolicy`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{resource=billingAccounts/*}:setIamPolicy', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) + pb_request = 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_iam_policy(resp) + return resp + + class _TestIamPermissions(CloudBillingRestStub): + def __hash__(self): + return hash("TestIamPermissions") + + __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: iam_policy_pb2.TestIamPermissionsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Call the test iam permissions method over HTTP. + + Args: + request (~.iam_policy_pb2.TestIamPermissionsRequest): + The request object. Request message for ``TestIamPermissions`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.iam_policy_pb2.TestIamPermissionsResponse: + Response message for ``TestIamPermissions`` method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{resource=billingAccounts/*}:testIamPermissions', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_test_iam_permissions(request, metadata) + pb_request = 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 = iam_policy_pb2.TestIamPermissionsResponse() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_test_iam_permissions(resp) + return resp + + class _UpdateBillingAccount(CloudBillingRestStub): + def __hash__(self): + return hash("UpdateBillingAccount") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.UpdateBillingAccountRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.BillingAccount: + r"""Call the update billing account method over HTTP. + + Args: + request (~.cloud_billing.UpdateBillingAccountRequest): + The request object. Request message for ``UpdateBillingAccount``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.BillingAccount: + A billing account in the `Google Cloud + Console `__. You can + assign a billing account to one or more projects. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{name=billingAccounts/*}', + 'body': 'account', + }, + ] + request, metadata = self._interceptor.pre_update_billing_account(request, metadata) + pb_request = cloud_billing.UpdateBillingAccountRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.BillingAccount() + pb_resp = cloud_billing.BillingAccount.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_billing_account(resp) + return resp + + class _UpdateProjectBillingInfo(CloudBillingRestStub): + def __hash__(self): + return hash("UpdateProjectBillingInfo") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_billing.UpdateProjectBillingInfoRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_billing.ProjectBillingInfo: + r"""Call the update project billing + info method over HTTP. + + Args: + request (~.cloud_billing.UpdateProjectBillingInfoRequest): + The request object. Request message for ``UpdateProjectBillingInfo``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_billing.ProjectBillingInfo: + Encapsulation of billing information + for a Google Cloud Console project. A + project has at most one associated + billing account at a time (but a billing + account can be assigned to multiple + projects). + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v1/{name=projects/*}/billingInfo', + 'body': 'project_billing_info', + }, + ] + request, metadata = self._interceptor.pre_update_project_billing_info(request, metadata) + pb_request = cloud_billing.UpdateProjectBillingInfoRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_billing.ProjectBillingInfo() + pb_resp = cloud_billing.ProjectBillingInfo.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_project_billing_info(resp) + return resp + + @property + def create_billing_account(self) -> Callable[ + [cloud_billing.CreateBillingAccountRequest], + cloud_billing.BillingAccount]: + # 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._CreateBillingAccount(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_billing_account(self) -> Callable[ + [cloud_billing.GetBillingAccountRequest], + cloud_billing.BillingAccount]: + # 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._GetBillingAccount(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + policy_pb2.Policy]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_project_billing_info(self) -> Callable[ + [cloud_billing.GetProjectBillingInfoRequest], + cloud_billing.ProjectBillingInfo]: + # 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._GetProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_billing_accounts(self) -> Callable[ + [cloud_billing.ListBillingAccountsRequest], + cloud_billing.ListBillingAccountsResponse]: + # 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._ListBillingAccounts(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_project_billing_info(self) -> Callable[ + [cloud_billing.ListProjectBillingInfoRequest], + cloud_billing.ListProjectBillingInfoResponse]: + # 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._ListProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + policy_pb2.Policy]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_billing_account(self) -> Callable[ + [cloud_billing.UpdateBillingAccountRequest], + cloud_billing.BillingAccount]: + # 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._UpdateBillingAccount(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_project_billing_info(self) -> Callable[ + [cloud_billing.UpdateProjectBillingInfoRequest], + cloud_billing.ProjectBillingInfo]: + # 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._UpdateProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'CloudBillingRestTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py new file mode 100644 index 000000000000..837679acc7ed --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__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 CloudCatalogClient +from .async_client import CloudCatalogAsyncClient + +__all__ = ( + 'CloudCatalogClient', + 'CloudCatalogAsyncClient', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py new file mode 100644 index 000000000000..20464a919d01 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py @@ -0,0 +1,399 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_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.cloud.billing_v1.services.cloud_catalog import pagers +from google.cloud.billing_v1.types import cloud_catalog +from .transports.base import CloudCatalogTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import CloudCatalogGrpcAsyncIOTransport +from .client import CloudCatalogClient + + +class CloudCatalogAsyncClient: + """A catalog of Google Cloud Platform services and SKUs. + Provides pricing information and metadata on Google Cloud + Platform services and SKUs. + """ + + _client: CloudCatalogClient + + DEFAULT_ENDPOINT = CloudCatalogClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = CloudCatalogClient.DEFAULT_MTLS_ENDPOINT + + service_path = staticmethod(CloudCatalogClient.service_path) + parse_service_path = staticmethod(CloudCatalogClient.parse_service_path) + sku_path = staticmethod(CloudCatalogClient.sku_path) + parse_sku_path = staticmethod(CloudCatalogClient.parse_sku_path) + common_billing_account_path = staticmethod(CloudCatalogClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(CloudCatalogClient.parse_common_billing_account_path) + common_folder_path = staticmethod(CloudCatalogClient.common_folder_path) + parse_common_folder_path = staticmethod(CloudCatalogClient.parse_common_folder_path) + common_organization_path = staticmethod(CloudCatalogClient.common_organization_path) + parse_common_organization_path = staticmethod(CloudCatalogClient.parse_common_organization_path) + common_project_path = staticmethod(CloudCatalogClient.common_project_path) + parse_common_project_path = staticmethod(CloudCatalogClient.parse_common_project_path) + common_location_path = staticmethod(CloudCatalogClient.common_location_path) + parse_common_location_path = staticmethod(CloudCatalogClient.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: + CloudCatalogAsyncClient: The constructed client. + """ + return CloudCatalogClient.from_service_account_info.__func__(CloudCatalogAsyncClient, 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: + CloudCatalogAsyncClient: The constructed client. + """ + return CloudCatalogClient.from_service_account_file.__func__(CloudCatalogAsyncClient, 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 CloudCatalogClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> CloudCatalogTransport: + """Returns the transport used by the client instance. + + Returns: + CloudCatalogTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(CloudCatalogClient).get_transport_class, type(CloudCatalogClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, CloudCatalogTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud catalog 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, ~.CloudCatalogTransport]): 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 = CloudCatalogClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_services(self, + request: Optional[Union[cloud_catalog.ListServicesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListServicesAsyncPager: + r"""Lists all public cloud services. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_list_services(): + # Create a client + client = billing_v1.CloudCatalogAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListServicesRequest( + ) + + # Make the request + page_result = client.list_services(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.ListServicesRequest, dict]]): + The request object. Request message for ``ListServices``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager: + Response message for ListServices. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + request = cloud_catalog.ListServicesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_services, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # 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.ListServicesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_skus(self, + request: Optional[Union[cloud_catalog.ListSkusRequest, 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.ListSkusAsyncPager: + r"""Lists all publicly available SKUs for a given cloud + service. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + async def sample_list_skus(): + # Create a client + client = billing_v1.CloudCatalogAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListSkusRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_skus(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.billing_v1.types.ListSkusRequest, dict]]): + The request object. Request message for ``ListSkus``. + parent (:class:`str`): + Required. The name of the service. + Example: "services/DA34-426B-A397" + + 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.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager: + Response message for ListSkus. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_catalog.ListSkusRequest(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_skus, + default_timeout=60.0, + 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.ListSkusAsyncPager( + method=rpc, + request=request, + response=response, + 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__ = ( + "CloudCatalogAsyncClient", +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py new file mode 100644 index 000000000000..80a18d0f9bcb --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py @@ -0,0 +1,613 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_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.cloud.billing_v1.services.cloud_catalog import pagers +from google.cloud.billing_v1.types import cloud_catalog +from .transports.base import CloudCatalogTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import CloudCatalogGrpcTransport +from .transports.grpc_asyncio import CloudCatalogGrpcAsyncIOTransport +from .transports.rest import CloudCatalogRestTransport + + +class CloudCatalogClientMeta(type): + """Metaclass for the CloudCatalog 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[CloudCatalogTransport]] + _transport_registry["grpc"] = CloudCatalogGrpcTransport + _transport_registry["grpc_asyncio"] = CloudCatalogGrpcAsyncIOTransport + _transport_registry["rest"] = CloudCatalogRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[CloudCatalogTransport]: + """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 CloudCatalogClient(metaclass=CloudCatalogClientMeta): + """A catalog of Google Cloud Platform services and SKUs. + Provides pricing information and metadata on Google Cloud + Platform services and SKUs. + """ + + @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 = "cloudbilling.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: + CloudCatalogClient: 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: + CloudCatalogClient: 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) -> CloudCatalogTransport: + """Returns the transport used by the client instance. + + Returns: + CloudCatalogTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def service_path(service: str,) -> str: + """Returns a fully-qualified service string.""" + return "services/{service}".format(service=service, ) + + @staticmethod + def parse_service_path(path: str) -> Dict[str,str]: + """Parses a service path into its component segments.""" + m = re.match(r"^services/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def sku_path(service: str,sku: str,) -> str: + """Returns a fully-qualified sku string.""" + return "services/{service}/skus/{sku}".format(service=service, sku=sku, ) + + @staticmethod + def parse_sku_path(path: str) -> Dict[str,str]: + """Parses a sku path into its component segments.""" + m = re.match(r"^services/(?P.+?)/skus/(?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, CloudCatalogTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud catalog 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, CloudCatalogTransport]): 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, CloudCatalogTransport): + # transport is a CloudCatalogTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def list_services(self, + request: Optional[Union[cloud_catalog.ListServicesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListServicesPager: + r"""Lists all public cloud services. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_list_services(): + # Create a client + client = billing_v1.CloudCatalogClient() + + # Initialize request argument(s) + request = billing_v1.ListServicesRequest( + ) + + # Make the request + page_result = client.list_services(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.ListServicesRequest, dict]): + The request object. Request message for ``ListServices``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.billing_v1.services.cloud_catalog.pagers.ListServicesPager: + Response message for ListServices. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_catalog.ListServicesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_catalog.ListServicesRequest): + request = cloud_catalog.ListServicesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_services] + + # 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.ListServicesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_skus(self, + request: Optional[Union[cloud_catalog.ListSkusRequest, 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.ListSkusPager: + r"""Lists all publicly available SKUs for a given cloud + service. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import billing_v1 + + def sample_list_skus(): + # Create a client + client = billing_v1.CloudCatalogClient() + + # Initialize request argument(s) + request = billing_v1.ListSkusRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_skus(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.billing_v1.types.ListSkusRequest, dict]): + The request object. Request message for ``ListSkus``. + parent (str): + Required. The name of the service. + Example: "services/DA34-426B-A397" + + 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.billing_v1.services.cloud_catalog.pagers.ListSkusPager: + Response message for ListSkus. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_catalog.ListSkusRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_catalog.ListSkusRequest): + request = cloud_catalog.ListSkusRequest(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_skus] + + # 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.ListSkusPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "CloudCatalogClient": + 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__ = ( + "CloudCatalogClient", +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py new file mode 100644 index 000000000000..6faee2d8cc0e --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_v1.types import cloud_catalog + + +class ListServicesPager: + """A pager for iterating through ``list_services`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListServicesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``services`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListServices`` requests and continue to iterate + through the ``services`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListServicesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_catalog.ListServicesResponse], + request: cloud_catalog.ListServicesRequest, + response: cloud_catalog.ListServicesResponse, + *, + 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.billing_v1.types.ListServicesRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListServicesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_catalog.ListServicesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_catalog.ListServicesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_catalog.Service]: + for page in self.pages: + yield from page.services + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListServicesAsyncPager: + """A pager for iterating through ``list_services`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListServicesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``services`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListServices`` requests and continue to iterate + through the ``services`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListServicesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_catalog.ListServicesResponse]], + request: cloud_catalog.ListServicesRequest, + response: cloud_catalog.ListServicesResponse, + *, + 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.billing_v1.types.ListServicesRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListServicesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_catalog.ListServicesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_catalog.ListServicesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_catalog.Service]: + async def async_generator(): + async for page in self.pages: + for response in page.services: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListSkusPager: + """A pager for iterating through ``list_skus`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListSkusResponse` object, and + provides an ``__iter__`` method to iterate through its + ``skus`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListSkus`` requests and continue to iterate + through the ``skus`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListSkusResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_catalog.ListSkusResponse], + request: cloud_catalog.ListSkusRequest, + response: cloud_catalog.ListSkusResponse, + *, + 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.billing_v1.types.ListSkusRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListSkusResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_catalog.ListSkusRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_catalog.ListSkusResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_catalog.Sku]: + for page in self.pages: + yield from page.skus + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListSkusAsyncPager: + """A pager for iterating through ``list_skus`` requests. + + This class thinly wraps an initial + :class:`google.cloud.billing_v1.types.ListSkusResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``skus`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListSkus`` requests and continue to iterate + through the ``skus`` field on the + corresponding responses. + + All the usual :class:`google.cloud.billing_v1.types.ListSkusResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_catalog.ListSkusResponse]], + request: cloud_catalog.ListSkusRequest, + response: cloud_catalog.ListSkusResponse, + *, + 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.billing_v1.types.ListSkusRequest): + The initial request object. + response (google.cloud.billing_v1.types.ListSkusResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_catalog.ListSkusRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_catalog.ListSkusResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_catalog.Sku]: + async def async_generator(): + async for page in self.pages: + for response in page.skus: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py new file mode 100644 index 000000000000..f6dd41c9ea9a --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/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 CloudCatalogTransport +from .grpc import CloudCatalogGrpcTransport +from .grpc_asyncio import CloudCatalogGrpcAsyncIOTransport +from .rest import CloudCatalogRestTransport +from .rest import CloudCatalogRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[CloudCatalogTransport]] +_transport_registry['grpc'] = CloudCatalogGrpcTransport +_transport_registry['grpc_asyncio'] = CloudCatalogGrpcAsyncIOTransport +_transport_registry['rest'] = CloudCatalogRestTransport + +__all__ = ( + 'CloudCatalogTransport', + 'CloudCatalogGrpcTransport', + 'CloudCatalogGrpcAsyncIOTransport', + 'CloudCatalogRestTransport', + 'CloudCatalogRestInterceptor', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py new file mode 100644 index 000000000000..cbc3176979d5 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py @@ -0,0 +1,164 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.billing_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.billing_v1.types import cloud_catalog + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class CloudCatalogTransport(abc.ABC): + """Abstract transport class for CloudCatalog.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'cloudbilling.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_services: gapic_v1.method.wrap_method( + self.list_services, + default_timeout=60.0, + client_info=client_info, + ), + self.list_skus: gapic_v1.method.wrap_method( + self.list_skus, + default_timeout=60.0, + 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 list_services(self) -> Callable[ + [cloud_catalog.ListServicesRequest], + Union[ + cloud_catalog.ListServicesResponse, + Awaitable[cloud_catalog.ListServicesResponse] + ]]: + raise NotImplementedError() + + @property + def list_skus(self) -> Callable[ + [cloud_catalog.ListSkusRequest], + Union[ + cloud_catalog.ListSkusResponse, + Awaitable[cloud_catalog.ListSkusResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'CloudCatalogTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py new file mode 100644 index 000000000000..8d2e8587fae0 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py @@ -0,0 +1,293 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 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.billing_v1.types import cloud_catalog +from .base import CloudCatalogTransport, DEFAULT_CLIENT_INFO + + +class CloudCatalogGrpcTransport(CloudCatalogTransport): + """gRPC backend transport for CloudCatalog. + + A catalog of Google Cloud Platform services and SKUs. + Provides pricing information and metadata on Google Cloud + Platform services and SKUs. + + 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 = 'cloudbilling.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] = {} + + 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 = 'cloudbilling.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 list_services(self) -> Callable[ + [cloud_catalog.ListServicesRequest], + cloud_catalog.ListServicesResponse]: + r"""Return a callable for the list services method over gRPC. + + Lists all public cloud services. + + Returns: + Callable[[~.ListServicesRequest], + ~.ListServicesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_services' not in self._stubs: + self._stubs['list_services'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudCatalog/ListServices', + request_serializer=cloud_catalog.ListServicesRequest.serialize, + response_deserializer=cloud_catalog.ListServicesResponse.deserialize, + ) + return self._stubs['list_services'] + + @property + def list_skus(self) -> Callable[ + [cloud_catalog.ListSkusRequest], + cloud_catalog.ListSkusResponse]: + r"""Return a callable for the list skus method over gRPC. + + Lists all publicly available SKUs for a given cloud + service. + + Returns: + Callable[[~.ListSkusRequest], + ~.ListSkusResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_skus' not in self._stubs: + self._stubs['list_skus'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudCatalog/ListSkus', + request_serializer=cloud_catalog.ListSkusRequest.serialize, + response_deserializer=cloud_catalog.ListSkusResponse.deserialize, + ) + return self._stubs['list_skus'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'CloudCatalogGrpcTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py new file mode 100644 index 000000000000..82a2bd24dbd8 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py @@ -0,0 +1,292 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.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.billing_v1.types import cloud_catalog +from .base import CloudCatalogTransport, DEFAULT_CLIENT_INFO +from .grpc import CloudCatalogGrpcTransport + + +class CloudCatalogGrpcAsyncIOTransport(CloudCatalogTransport): + """gRPC AsyncIO backend transport for CloudCatalog. + + A catalog of Google Cloud Platform services and SKUs. + Provides pricing information and metadata on Google Cloud + Platform services and SKUs. + + 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 = 'cloudbilling.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 = 'cloudbilling.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] = {} + + 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 list_services(self) -> Callable[ + [cloud_catalog.ListServicesRequest], + Awaitable[cloud_catalog.ListServicesResponse]]: + r"""Return a callable for the list services method over gRPC. + + Lists all public cloud services. + + Returns: + Callable[[~.ListServicesRequest], + Awaitable[~.ListServicesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_services' not in self._stubs: + self._stubs['list_services'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudCatalog/ListServices', + request_serializer=cloud_catalog.ListServicesRequest.serialize, + response_deserializer=cloud_catalog.ListServicesResponse.deserialize, + ) + return self._stubs['list_services'] + + @property + def list_skus(self) -> Callable[ + [cloud_catalog.ListSkusRequest], + Awaitable[cloud_catalog.ListSkusResponse]]: + r"""Return a callable for the list skus method over gRPC. + + Lists all publicly available SKUs for a given cloud + service. + + Returns: + Callable[[~.ListSkusRequest], + Awaitable[~.ListSkusResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_skus' not in self._stubs: + self._stubs['list_skus'] = self.grpc_channel.unary_unary( + '/google.cloud.billing.v1.CloudCatalog/ListSkus', + request_serializer=cloud_catalog.ListSkusRequest.serialize, + response_deserializer=cloud_catalog.ListSkusResponse.deserialize, + ) + return self._stubs['list_skus'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'CloudCatalogGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py new file mode 100644 index 000000000000..789e0f3b94b5 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py @@ -0,0 +1,392 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 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.billing_v1.types import cloud_catalog + +from .base import CloudCatalogTransport, 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 CloudCatalogRestInterceptor: + """Interceptor for CloudCatalog. + + 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 CloudCatalogRestTransport. + + .. code-block:: python + class MyCustomCloudCatalogInterceptor(CloudCatalogRestInterceptor): + def pre_list_services(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_services(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_skus(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_skus(self, response): + logging.log(f"Received response: {response}") + return response + + transport = CloudCatalogRestTransport(interceptor=MyCustomCloudCatalogInterceptor()) + client = CloudCatalogClient(transport=transport) + + + """ + def pre_list_services(self, request: cloud_catalog.ListServicesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_catalog.ListServicesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_services + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudCatalog server. + """ + return request, metadata + + def post_list_services(self, response: cloud_catalog.ListServicesResponse) -> cloud_catalog.ListServicesResponse: + """Post-rpc interceptor for list_services + + Override in a subclass to manipulate the response + after it is returned by the CloudCatalog server but before + it is returned to user code. + """ + return response + def pre_list_skus(self, request: cloud_catalog.ListSkusRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_catalog.ListSkusRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_skus + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudCatalog server. + """ + return request, metadata + + def post_list_skus(self, response: cloud_catalog.ListSkusResponse) -> cloud_catalog.ListSkusResponse: + """Post-rpc interceptor for list_skus + + Override in a subclass to manipulate the response + after it is returned by the CloudCatalog server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class CloudCatalogRestStub: + _session: AuthorizedSession + _host: str + _interceptor: CloudCatalogRestInterceptor + + +class CloudCatalogRestTransport(CloudCatalogTransport): + """REST backend transport for CloudCatalog. + + A catalog of Google Cloud Platform services and SKUs. + Provides pricing information and metadata on Google Cloud + Platform services and SKUs. + + 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 = 'cloudbilling.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[CloudCatalogRestInterceptor] = 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) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or CloudCatalogRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListServices(CloudCatalogRestStub): + def __hash__(self): + return hash("ListServices") + + def __call__(self, + request: cloud_catalog.ListServicesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_catalog.ListServicesResponse: + r"""Call the list services method over HTTP. + + Args: + request (~.cloud_catalog.ListServicesRequest): + The request object. Request message for ``ListServices``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_catalog.ListServicesResponse: + Response message for ``ListServices``. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/services', + }, + ] + request, metadata = self._interceptor.pre_list_services(request, metadata) + pb_request = cloud_catalog.ListServicesRequest.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["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_catalog.ListServicesResponse() + pb_resp = cloud_catalog.ListServicesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_services(resp) + return resp + + class _ListSkus(CloudCatalogRestStub): + def __hash__(self): + return hash("ListSkus") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_catalog.ListSkusRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_catalog.ListSkusResponse: + r"""Call the list skus method over HTTP. + + Args: + request (~.cloud_catalog.ListSkusRequest): + The request object. Request message for ``ListSkus``. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_catalog.ListSkusResponse: + Response message for ``ListSkus``. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=services/*}/skus', + }, + ] + request, metadata = self._interceptor.pre_list_skus(request, metadata) + pb_request = cloud_catalog.ListSkusRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_catalog.ListSkusResponse() + pb_resp = cloud_catalog.ListSkusResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_skus(resp) + return resp + + @property + def list_services(self) -> Callable[ + [cloud_catalog.ListServicesRequest], + cloud_catalog.ListServicesResponse]: + # 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._ListServices(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_skus(self) -> Callable[ + [cloud_catalog.ListSkusRequest], + cloud_catalog.ListSkusResponse]: + # 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._ListSkus(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'CloudCatalogRestTransport', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py new file mode 100644 index 000000000000..3da592e0c88a --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_billing import ( + BillingAccount, + CreateBillingAccountRequest, + GetBillingAccountRequest, + GetProjectBillingInfoRequest, + ListBillingAccountsRequest, + ListBillingAccountsResponse, + ListProjectBillingInfoRequest, + ListProjectBillingInfoResponse, + ProjectBillingInfo, + UpdateBillingAccountRequest, + UpdateProjectBillingInfoRequest, +) +from .cloud_catalog import ( + AggregationInfo, + Category, + GeoTaxonomy, + ListServicesRequest, + ListServicesResponse, + ListSkusRequest, + ListSkusResponse, + PricingExpression, + PricingInfo, + Service, + Sku, +) + +__all__ = ( + 'BillingAccount', + 'CreateBillingAccountRequest', + 'GetBillingAccountRequest', + 'GetProjectBillingInfoRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'ProjectBillingInfo', + 'UpdateBillingAccountRequest', + 'UpdateProjectBillingInfoRequest', + 'AggregationInfo', + 'Category', + 'GeoTaxonomy', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + 'PricingExpression', + 'PricingInfo', + 'Service', + 'Sku', +) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py new file mode 100644 index 000000000000..6d3d851fb89c --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py @@ -0,0 +1,377 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.billing.v1', + manifest={ + 'BillingAccount', + 'ProjectBillingInfo', + 'GetBillingAccountRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'CreateBillingAccountRequest', + 'UpdateBillingAccountRequest', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'GetProjectBillingInfoRequest', + 'UpdateProjectBillingInfoRequest', + }, +) + + +class BillingAccount(proto.Message): + r"""A billing account in the `Google Cloud + Console `__. You can assign a + billing account to one or more projects. + + Attributes: + name (str): + Output only. The resource name of the billing account. The + resource name has the form + ``billingAccounts/{billing_account_id}``. For example, + ``billingAccounts/012345-567890-ABCDEF`` would be the + resource name for billing account ``012345-567890-ABCDEF``. + open_ (bool): + Output only. True if the billing account is + open, and will therefore be charged for any + usage on associated projects. False if the + billing account is closed, and therefore + projects associated with it will be unable to + use paid services. + display_name (str): + The display name given to the billing account, such as + ``My Billing Account``. This name is displayed in the Google + Cloud Console. + master_billing_account (str): + If this account is a + `subaccount `__, + then this will be the resource name of the parent billing + account that it is being resold through. Otherwise this will + be empty. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + open_: bool = proto.Field( + proto.BOOL, + number=2, + ) + display_name: str = proto.Field( + proto.STRING, + number=3, + ) + master_billing_account: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ProjectBillingInfo(proto.Message): + r"""Encapsulation of billing information for a Google Cloud + Console project. A project has at most one associated billing + account at a time (but a billing account can be assigned to + multiple projects). + + Attributes: + name (str): + Output only. The resource name for the + ``ProjectBillingInfo``; has the form + ``projects/{project_id}/billingInfo``. For example, the + resource name for the billing information for project + ``tokyo-rain-123`` would be + ``projects/tokyo-rain-123/billingInfo``. This field is + read-only. + project_id (str): + Output only. The ID of the project that this + ``ProjectBillingInfo`` represents, such as + ``tokyo-rain-123``. This is a convenience field so that you + don't need to parse the ``name`` field to obtain a project + ID. This field is read-only. + billing_account_name (str): + The resource name of the billing account associated with the + project, if any. For example, + ``billingAccounts/012345-567890-ABCDEF``. + billing_enabled (bool): + Output only. True if the project is + associated with an open billing account, to + which usage on the project is charged. False if + the project is associated with a closed billing + account, or no billing account at all, and + therefore cannot use paid services. This field + is read-only. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + project_id: str = proto.Field( + proto.STRING, + number=2, + ) + billing_account_name: str = proto.Field( + proto.STRING, + number=3, + ) + billing_enabled: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class GetBillingAccountRequest(proto.Message): + r"""Request message for ``GetBillingAccount``. + + Attributes: + name (str): + Required. The resource name of the billing account to + retrieve. For example, + ``billingAccounts/012345-567890-ABCDEF``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListBillingAccountsRequest(proto.Message): + r"""Request message for ``ListBillingAccounts``. + + Attributes: + page_size (int): + Requested page size. The maximum page size is + 100; this is also the default. + page_token (str): + A token identifying a page of results to return. This should + be a ``next_page_token`` value returned from a previous + ``ListBillingAccounts`` call. If unspecified, the first page + of results is returned. + filter (str): + Options for how to filter the returned billing accounts. + Currently this only supports filtering for + `subaccounts `__ + under a single provided reseller billing account. (e.g. + "master_billing_account=billingAccounts/012345-678901-ABCDEF"). + Boolean algebra and other fields are not currently + supported. + """ + + page_size: int = proto.Field( + proto.INT32, + number=1, + ) + page_token: str = proto.Field( + proto.STRING, + number=2, + ) + filter: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListBillingAccountsResponse(proto.Message): + r"""Response message for ``ListBillingAccounts``. + + Attributes: + billing_accounts (MutableSequence[google.cloud.billing_v1.types.BillingAccount]): + A list of billing accounts. + next_page_token (str): + A token to retrieve the next page of results. To retrieve + the next page, call ``ListBillingAccounts`` again with the + ``page_token`` field set to this value. This field is empty + if there are no more results to retrieve. + """ + + @property + def raw_page(self): + return self + + billing_accounts: MutableSequence['BillingAccount'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='BillingAccount', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class CreateBillingAccountRequest(proto.Message): + r"""Request message for ``CreateBillingAccount``. + + Attributes: + billing_account (google.cloud.billing_v1.types.BillingAccount): + Required. The billing account resource to + create. Currently CreateBillingAccount only + supports subaccount creation, so any created + billing accounts must be under a provided parent + billing account. + """ + + billing_account: 'BillingAccount' = proto.Field( + proto.MESSAGE, + number=1, + message='BillingAccount', + ) + + +class UpdateBillingAccountRequest(proto.Message): + r"""Request message for ``UpdateBillingAccount``. + + Attributes: + name (str): + Required. The name of the billing account + resource to be updated. + account (google.cloud.billing_v1.types.BillingAccount): + Required. The billing account resource to + replace the resource on the server. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The update mask applied to the resource. Only "display_name" + is currently supported. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + account: 'BillingAccount' = proto.Field( + proto.MESSAGE, + number=2, + message='BillingAccount', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + + +class ListProjectBillingInfoRequest(proto.Message): + r"""Request message for ``ListProjectBillingInfo``. + + Attributes: + name (str): + Required. The resource name of the billing account + associated with the projects that you want to list. For + example, ``billingAccounts/012345-567890-ABCDEF``. + page_size (int): + Requested page size. The maximum page size is + 100; this is also the default. + page_token (str): + A token identifying a page of results to be returned. This + should be a ``next_page_token`` value returned from a + previous ``ListProjectBillingInfo`` call. If unspecified, + the first page of results is returned. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListProjectBillingInfoResponse(proto.Message): + r"""Request message for ``ListProjectBillingInfoResponse``. + + Attributes: + project_billing_info (MutableSequence[google.cloud.billing_v1.types.ProjectBillingInfo]): + A list of ``ProjectBillingInfo`` resources representing the + projects associated with the billing account. + next_page_token (str): + A token to retrieve the next page of results. To retrieve + the next page, call ``ListProjectBillingInfo`` again with + the ``page_token`` field set to this value. This field is + empty if there are no more results to retrieve. + """ + + @property + def raw_page(self): + return self + + project_billing_info: MutableSequence['ProjectBillingInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='ProjectBillingInfo', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetProjectBillingInfoRequest(proto.Message): + r"""Request message for ``GetProjectBillingInfo``. + + Attributes: + name (str): + Required. The resource name of the project for which billing + information is retrieved. For example, + ``projects/tokyo-rain-123``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateProjectBillingInfoRequest(proto.Message): + r"""Request message for ``UpdateProjectBillingInfo``. + + Attributes: + name (str): + Required. The resource name of the project associated with + the billing information that you want to update. For + example, ``projects/tokyo-rain-123``. + project_billing_info (google.cloud.billing_v1.types.ProjectBillingInfo): + The new billing information for the project. Read-only + fields are ignored; thus, you can leave empty all fields + except ``billing_account_name``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + project_billing_info: 'ProjectBillingInfo' = proto.Field( + proto.MESSAGE, + number=2, + message='ProjectBillingInfo', + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py new file mode 100644 index 000000000000..813a6520a5fd --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py @@ -0,0 +1,602 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.billing.v1', + manifest={ + 'Service', + 'Sku', + 'Category', + 'PricingInfo', + 'PricingExpression', + 'AggregationInfo', + 'GeoTaxonomy', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + }, +) + + +class Service(proto.Message): + r"""Encapsulates a single service in Google Cloud Platform. + + Attributes: + name (str): + The resource name for the service. + Example: "services/DA34-426B-A397". + service_id (str): + The identifier for the service. + Example: "DA34-426B-A397". + display_name (str): + A human readable display name for this + service. + business_entity_name (str): + The business under which the service is + offered. Ex. "businessEntities/GCP", + "businessEntities/Maps". + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + service_id: str = proto.Field( + proto.STRING, + number=2, + ) + display_name: str = proto.Field( + proto.STRING, + number=3, + ) + business_entity_name: str = proto.Field( + proto.STRING, + number=4, + ) + + +class Sku(proto.Message): + r"""Encapsulates a single SKU in Google Cloud Platform + + Attributes: + name (str): + The resource name for the SKU. + Example: + "services/DA34-426B-A397/skus/AA95-CD31-42FE". + sku_id (str): + The identifier for the SKU. + Example: "AA95-CD31-42FE". + description (str): + A human readable description of the SKU, has + a maximum length of 256 characters. + category (google.cloud.billing_v1.types.Category): + The category hierarchy of this SKU, purely + for organizational purpose. + service_regions (MutableSequence[str]): + List of service regions this SKU is offered + at. Example: "asia-east1" + Service regions can be found at + https://cloud.google.com/about/locations/ + pricing_info (MutableSequence[google.cloud.billing_v1.types.PricingInfo]): + A timeline of pricing info for this SKU in + chronological order. + service_provider_name (str): + Identifies the service provider. + This is 'Google' for first party services in + Google Cloud Platform. + geo_taxonomy (google.cloud.billing_v1.types.GeoTaxonomy): + The geographic taxonomy for this sku. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + sku_id: str = proto.Field( + proto.STRING, + number=2, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + category: 'Category' = proto.Field( + proto.MESSAGE, + number=4, + message='Category', + ) + service_regions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=5, + ) + pricing_info: MutableSequence['PricingInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='PricingInfo', + ) + service_provider_name: str = proto.Field( + proto.STRING, + number=7, + ) + geo_taxonomy: 'GeoTaxonomy' = proto.Field( + proto.MESSAGE, + number=8, + message='GeoTaxonomy', + ) + + +class Category(proto.Message): + r"""Represents the category hierarchy of a SKU. + + Attributes: + service_display_name (str): + The display name of the service this SKU + belongs to. + resource_family (str): + The type of product the SKU refers to. + Example: "Compute", "Storage", "Network", + "ApplicationServices" etc. + resource_group (str): + A group classification for related SKUs. + Example: "RAM", "GPU", "Prediction", "Ops", + "GoogleEgress" etc. + usage_type (str): + Represents how the SKU is consumed. + Example: "OnDemand", "Preemptible", "Commit1Mo", + "Commit1Yr" etc. + """ + + service_display_name: str = proto.Field( + proto.STRING, + number=1, + ) + resource_family: str = proto.Field( + proto.STRING, + number=2, + ) + resource_group: str = proto.Field( + proto.STRING, + number=3, + ) + usage_type: str = proto.Field( + proto.STRING, + number=4, + ) + + +class PricingInfo(proto.Message): + r"""Represents the pricing information for a SKU at a single + point of time. + + Attributes: + effective_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp from which this pricing was effective within + the requested time range. This is guaranteed to be greater + than or equal to the start_time field in the request and + less than the end_time field in the request. If a time range + was not specified in the request this field will be + equivalent to a time within the last 12 hours, indicating + the latest pricing info. + summary (str): + An optional human readable summary of the + pricing information, has a maximum length of 256 + characters. + pricing_expression (google.cloud.billing_v1.types.PricingExpression): + Expresses the pricing formula. See ``PricingExpression`` for + an example. + aggregation_info (google.cloud.billing_v1.types.AggregationInfo): + Aggregation Info. This can be left + unspecified if the pricing expression doesn't + require aggregation. + currency_conversion_rate (float): + Conversion rate used for currency conversion, from USD to + the currency specified in the request. This includes any + surcharge collected for billing in non USD currency. If a + currency is not specified in the request this defaults to + 1.0. Example: USD \* currency_conversion_rate = JPY + """ + + effective_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + summary: str = proto.Field( + proto.STRING, + number=2, + ) + pricing_expression: 'PricingExpression' = proto.Field( + proto.MESSAGE, + number=3, + message='PricingExpression', + ) + aggregation_info: 'AggregationInfo' = proto.Field( + proto.MESSAGE, + number=4, + message='AggregationInfo', + ) + currency_conversion_rate: float = proto.Field( + proto.DOUBLE, + number=5, + ) + + +class PricingExpression(proto.Message): + r"""Expresses a mathematical pricing formula. For Example:- + + ``usage_unit: GBy`` ``tiered_rates:`` + ``[start_usage_amount: 20, unit_price: $10]`` + ``[start_usage_amount: 100, unit_price: $5]`` + + The above expresses a pricing formula where the first 20GB is free, + the next 80GB is priced at $10 per GB followed by $5 per GB for + additional usage. + + Attributes: + usage_unit (str): + The short hand for unit of usage this pricing is specified + in. Example: usage_unit of "GiBy" means that usage is + specified in "Gibi Byte". + display_quantity (float): + The recommended quantity of units for displaying pricing + info. When displaying pricing info it is recommended to + display: (unit_price \* display_quantity) per + display_quantity usage_unit. This field does not affect the + pricing formula and is for display purposes only. Example: + If the unit_price is "0.0001 USD", the usage_unit is "GB" + and the display_quantity is "1000" then the recommended way + of displaying the pricing info is "0.10 USD per 1000 GB". + tiered_rates (MutableSequence[google.cloud.billing_v1.types.PricingExpression.TierRate]): + The list of tiered rates for this pricing. The total cost is + computed by applying each of the tiered rates on usage. This + repeated list is sorted by ascending order of + start_usage_amount. + usage_unit_description (str): + The unit of usage in human readable form. + Example: "gibi byte". + base_unit (str): + The base unit for the SKU which is the unit + used in usage exports. Example: "By". + base_unit_description (str): + The base unit in human readable form. + Example: "byte". + base_unit_conversion_factor (float): + Conversion factor for converting from price per usage_unit + to price per base_unit, and start_usage_amount to + start_usage_amount in base_unit. unit_price / + base_unit_conversion_factor = price per base_unit. + start_usage_amount \* base_unit_conversion_factor = + start_usage_amount in base_unit. + """ + + class TierRate(proto.Message): + r"""The price rate indicating starting usage and its + corresponding price. + + Attributes: + start_usage_amount (float): + Usage is priced at this rate only after this amount. + Example: start_usage_amount of 10 indicates that the usage + will be priced at the unit_price after the first 10 + usage_units. + unit_price (google.type.money_pb2.Money): + The price per unit of usage. Example: unit_price of amount + $10 indicates that each unit will cost $10. + """ + + start_usage_amount: float = proto.Field( + proto.DOUBLE, + number=1, + ) + unit_price: money_pb2.Money = proto.Field( + proto.MESSAGE, + number=2, + message=money_pb2.Money, + ) + + usage_unit: str = proto.Field( + proto.STRING, + number=1, + ) + display_quantity: float = proto.Field( + proto.DOUBLE, + number=2, + ) + tiered_rates: MutableSequence[TierRate] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=TierRate, + ) + usage_unit_description: str = proto.Field( + proto.STRING, + number=4, + ) + base_unit: str = proto.Field( + proto.STRING, + number=5, + ) + base_unit_description: str = proto.Field( + proto.STRING, + number=6, + ) + base_unit_conversion_factor: float = proto.Field( + proto.DOUBLE, + number=7, + ) + + +class AggregationInfo(proto.Message): + r"""Represents the aggregation level and interval for pricing of + a single SKU. + + Attributes: + aggregation_level (google.cloud.billing_v1.types.AggregationInfo.AggregationLevel): + + aggregation_interval (google.cloud.billing_v1.types.AggregationInfo.AggregationInterval): + + aggregation_count (int): + The number of intervals to aggregate over. Example: If + aggregation_level is "DAILY" and aggregation_count is 14, + aggregation will be over 14 days. + """ + class AggregationLevel(proto.Enum): + r"""The level at which usage is aggregated to compute cost. + Example: "ACCOUNT" aggregation level indicates that usage for + tiered pricing is aggregated across all projects in a single + account. + + Values: + AGGREGATION_LEVEL_UNSPECIFIED (0): + No description available. + ACCOUNT (1): + No description available. + PROJECT (2): + No description available. + """ + AGGREGATION_LEVEL_UNSPECIFIED = 0 + ACCOUNT = 1 + PROJECT = 2 + + class AggregationInterval(proto.Enum): + r"""The interval at which usage is aggregated to compute cost. + Example: "MONTHLY" aggregation interval indicates that usage for + tiered pricing is aggregated every month. + + Values: + AGGREGATION_INTERVAL_UNSPECIFIED (0): + No description available. + DAILY (1): + No description available. + MONTHLY (2): + No description available. + """ + AGGREGATION_INTERVAL_UNSPECIFIED = 0 + DAILY = 1 + MONTHLY = 2 + + aggregation_level: AggregationLevel = proto.Field( + proto.ENUM, + number=1, + enum=AggregationLevel, + ) + aggregation_interval: AggregationInterval = proto.Field( + proto.ENUM, + number=2, + enum=AggregationInterval, + ) + aggregation_count: int = proto.Field( + proto.INT32, + number=3, + ) + + +class GeoTaxonomy(proto.Message): + r"""Encapsulates the geographic taxonomy data for a sku. + + Attributes: + type_ (google.cloud.billing_v1.types.GeoTaxonomy.Type): + The type of Geo Taxonomy: GLOBAL, REGIONAL, or + MULTI_REGIONAL. + regions (MutableSequence[str]): + The list of regions associated with a sku. + Empty for Global skus, which are associated with + all Google Cloud regions. + """ + class Type(proto.Enum): + r"""The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL. + + Values: + TYPE_UNSPECIFIED (0): + The type is not specified. + GLOBAL (1): + The sku is global in nature, e.g. a license + sku. Global skus are available in all regions, + and so have an empty region list. + REGIONAL (2): + The sku is available in a specific region, + e.g. "us-west2". + MULTI_REGIONAL (3): + The sku is associated with multiple regions, + e.g. "us-west2" and "us-east1". + """ + TYPE_UNSPECIFIED = 0 + GLOBAL = 1 + REGIONAL = 2 + MULTI_REGIONAL = 3 + + type_: Type = proto.Field( + proto.ENUM, + number=1, + enum=Type, + ) + regions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class ListServicesRequest(proto.Message): + r"""Request message for ``ListServices``. + + Attributes: + page_size (int): + Requested page size. Defaults to 5000. + page_token (str): + A token identifying a page of results to return. This should + be a ``next_page_token`` value returned from a previous + ``ListServices`` call. If unspecified, the first page of + results is returned. + """ + + page_size: int = proto.Field( + proto.INT32, + number=1, + ) + page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ListServicesResponse(proto.Message): + r"""Response message for ``ListServices``. + + Attributes: + services (MutableSequence[google.cloud.billing_v1.types.Service]): + A list of services. + next_page_token (str): + A token to retrieve the next page of results. To retrieve + the next page, call ``ListServices`` again with the + ``page_token`` field set to this value. This field is empty + if there are no more results to retrieve. + """ + + @property + def raw_page(self): + return self + + services: MutableSequence['Service'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Service', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ListSkusRequest(proto.Message): + r"""Request message for ``ListSkus``. + + Attributes: + parent (str): + Required. The name of the service. + Example: "services/DA34-426B-A397". + start_time (google.protobuf.timestamp_pb2.Timestamp): + Optional inclusive start time of the time range for which + the pricing versions will be returned. Timestamps in the + future are not allowed. The time range has to be within a + single calendar month in America/Los_Angeles timezone. Time + range as a whole is optional. If not specified, the latest + pricing will be returned (up to 12 hours old at most). + end_time (google.protobuf.timestamp_pb2.Timestamp): + Optional exclusive end time of the time range for which the + pricing versions will be returned. Timestamps in the future + are not allowed. The time range has to be within a single + calendar month in America/Los_Angeles timezone. Time range + as a whole is optional. If not specified, the latest pricing + will be returned (up to 12 hours old at most). + currency_code (str): + The ISO 4217 currency code for the pricing info in the + response proto. Will use the conversion rate as of + start_time. Optional. If not specified USD will be used. + page_size (int): + Requested page size. Defaults to 5000. + page_token (str): + A token identifying a page of results to return. This should + be a ``next_page_token`` value returned from a previous + ``ListSkus`` call. If unspecified, the first page of results + is returned. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + currency_code: str = proto.Field( + proto.STRING, + number=4, + ) + page_size: int = proto.Field( + proto.INT32, + number=5, + ) + page_token: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListSkusResponse(proto.Message): + r"""Response message for ``ListSkus``. + + Attributes: + skus (MutableSequence[google.cloud.billing_v1.types.Sku]): + The list of public SKUs of the given service. + next_page_token (str): + A token to retrieve the next page of results. To retrieve + the next page, call ``ListSkus`` again with the + ``page_token`` field set to this value. This field is empty + if there are no more results to retrieve. + """ + + @property + def raw_page(self): + return self + + skus: MutableSequence['Sku'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Sku', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-billing/v1/mypy.ini b/owl-bot-staging/google-cloud-billing/v1/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-cloud-billing/v1/noxfile.py b/owl-bot-staging/google-cloud-billing/v1/noxfile.py new file mode 100644 index 000000000000..45e34dabb7c9 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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/billing_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/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py new file mode 100644 index 000000000000..07d988125cb3 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_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 billing_v1 + + +async def sample_create_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.CreateBillingAccountRequest( + ) + + # Make the request + response = await client.create_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py new file mode 100644 index 000000000000..f077b15d4915 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_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 billing_v1 + + +def sample_create_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.CreateBillingAccountRequest( + ) + + # Make the request + response = client.create_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py new file mode 100644 index 000000000000..103bd0db83a1 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_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 GetBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetBillingAccount_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 billing_v1 + + +async def sample_get_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.GetBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = await client.get_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetBillingAccount_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py new file mode 100644 index 000000000000..161219c852c3 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_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 GetBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetBillingAccount_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 billing_v1 + + +def sample_get_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.GetBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = client.get_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetBillingAccount_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py new file mode 100644 index 000000000000..3ca759d7ffb0 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_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 GetIamPolicy +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetIamPolicy_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_get_iam_policy(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.get_iam_policy(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetIamPolicy_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py new file mode 100644 index 000000000000..925b8e2de211 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_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 GetIamPolicy +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetIamPolicy_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_get_iam_policy(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.get_iam_policy(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetIamPolicy_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py new file mode 100644 index 000000000000..03df6579037f --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_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 GetProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_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 billing_v1 + + +async def sample_get_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.GetProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.get_project_billing_info(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py new file mode 100644 index 000000000000..e0b1cd9a4216 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_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 GetProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_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 billing_v1 + + +def sample_get_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.GetProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = client.get_project_billing_info(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py new file mode 100644 index 000000000000..ef0f2f5fdfa4 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_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 ListBillingAccounts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_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 billing_v1 + + +async def sample_list_billing_accounts(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListBillingAccountsRequest( + ) + + # Make the request + page_result = client.list_billing_accounts(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py new file mode 100644 index 000000000000..92ed39ab8444 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_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 ListBillingAccounts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_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 billing_v1 + + +def sample_list_billing_accounts(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.ListBillingAccountsRequest( + ) + + # Make the request + page_result = client.list_billing_accounts(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py new file mode 100644 index 000000000000..b692c04ca3c8 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_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 ListProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_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 billing_v1 + + +async def sample_list_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + page_result = client.list_project_billing_info(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py new file mode 100644 index 000000000000..82e8fd3a0df7 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_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 ListProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_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 billing_v1 + + +def sample_list_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.ListProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + page_result = client.list_project_billing_info(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py new file mode 100644 index 000000000000..eacaed6099e9 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_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 SetIamPolicy +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_SetIamPolicy_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_set_iam_policy(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.set_iam_policy(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_SetIamPolicy_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py new file mode 100644 index 000000000000..f30a28649865 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_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 SetIamPolicy +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_SetIamPolicy_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_set_iam_policy(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.set_iam_policy(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_SetIamPolicy_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py new file mode 100644 index 000000000000..257d37bc6509 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TestIamPermissions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_TestIamPermissions_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_test_iam_permissions(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = await client.test_iam_permissions(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_TestIamPermissions_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py new file mode 100644 index 000000000000..c685e45248dc --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TestIamPermissions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_TestIamPermissions_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import billing_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_test_iam_permissions(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = client.test_iam_permissions(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_TestIamPermissions_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py new file mode 100644 index 000000000000..ba3953e6adfc --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_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 UpdateBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_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 billing_v1 + + +async def sample_update_billing_account(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.UpdateBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = await client.update_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py new file mode 100644 index 000000000000..873d1904a4ca --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_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 UpdateBillingAccount +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_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 billing_v1 + + +def sample_update_billing_account(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.UpdateBillingAccountRequest( + name="name_value", + ) + + # Make the request + response = client.update_billing_account(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py new file mode 100644 index 000000000000..7ff0e87c93c5 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_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 UpdateProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_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 billing_v1 + + +async def sample_update_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingAsyncClient() + + # Initialize request argument(s) + request = billing_v1.UpdateProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.update_project_billing_info(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py new file mode 100644 index 000000000000..78b8cbd19c59 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_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 UpdateProjectBillingInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_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 billing_v1 + + +def sample_update_project_billing_info(): + # Create a client + client = billing_v1.CloudBillingClient() + + # Initialize request argument(s) + request = billing_v1.UpdateProjectBillingInfoRequest( + name="name_value", + ) + + # Make the request + response = client.update_project_billing_info(request=request) + + # Handle the response + print(response) + +# [END cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py new file mode 100644 index 000000000000..22259be8497b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_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 ListServices +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudCatalog_ListServices_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 billing_v1 + + +async def sample_list_services(): + # Create a client + client = billing_v1.CloudCatalogAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListServicesRequest( + ) + + # Make the request + page_result = client.list_services(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudCatalog_ListServices_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py new file mode 100644 index 000000000000..3b482cba3996 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_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 ListServices +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudCatalog_ListServices_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 billing_v1 + + +def sample_list_services(): + # Create a client + client = billing_v1.CloudCatalogClient() + + # Initialize request argument(s) + request = billing_v1.ListServicesRequest( + ) + + # Make the request + page_result = client.list_services(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudCatalog_ListServices_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py new file mode 100644 index 000000000000..2a8089fde307 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_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 ListSkus +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudCatalog_ListSkus_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 billing_v1 + + +async def sample_list_skus(): + # Create a client + client = billing_v1.CloudCatalogAsyncClient() + + # Initialize request argument(s) + request = billing_v1.ListSkusRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_skus(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudCatalog_ListSkus_async] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py new file mode 100644 index 000000000000..49fe647a6dcd --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_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 ListSkus +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-billing + + +# [START cloudbilling_v1_generated_CloudCatalog_ListSkus_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 billing_v1 + + +def sample_list_skus(): + # Create a client + client = billing_v1.CloudCatalogClient() + + # Initialize request argument(s) + request = billing_v1.ListSkusRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_skus(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudbilling_v1_generated_CloudCatalog_ListSkus_sync] diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json new file mode 100644 index 000000000000..baa168288190 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json @@ -0,0 +1,1955 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.billing.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-billing", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.create_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.CreateBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "CreateBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.CreateBillingAccountRequest" + }, + { + "name": "billing_account", + "type": "google.cloud.billing_v1.types.BillingAccount" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.BillingAccount", + "shortName": "create_billing_account" + }, + "description": "Sample for CreateBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.create_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.CreateBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "CreateBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.CreateBillingAccountRequest" + }, + { + "name": "billing_account", + "type": "google.cloud.billing_v1.types.BillingAccount" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.BillingAccount", + "shortName": "create_billing_account" + }, + "description": "Sample for CreateBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.get_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.GetBillingAccountRequest" + }, + { + "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.billing_v1.types.BillingAccount", + "shortName": "get_billing_account" + }, + "description": "Sample for GetBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetBillingAccount_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": "cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.get_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.GetBillingAccountRequest" + }, + { + "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.billing_v1.types.BillingAccount", + "shortName": "get_billing_account" + }, + "description": "Sample for GetBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetBillingAccount_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": "cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.get_iam_policy", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetIamPolicy", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.get_iam_policy", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetIamPolicy", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.get_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.GetProjectBillingInfoRequest" + }, + { + "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.billing_v1.types.ProjectBillingInfo", + "shortName": "get_project_billing_info" + }, + "description": "Sample for GetProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.get_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.GetProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "GetProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.GetProjectBillingInfoRequest" + }, + { + "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.billing_v1.types.ProjectBillingInfo", + "shortName": "get_project_billing_info" + }, + "description": "Sample for GetProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.list_billing_accounts", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.ListBillingAccounts", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "ListBillingAccounts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListBillingAccountsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager", + "shortName": "list_billing_accounts" + }, + "description": "Sample for ListBillingAccounts", + "file": "cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.list_billing_accounts", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.ListBillingAccounts", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "ListBillingAccounts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListBillingAccountsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager", + "shortName": "list_billing_accounts" + }, + "description": "Sample for ListBillingAccounts", + "file": "cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.list_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.ListProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "ListProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListProjectBillingInfoRequest" + }, + { + "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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager", + "shortName": "list_project_billing_info" + }, + "description": "Sample for ListProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.list_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.ListProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "ListProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListProjectBillingInfoRequest" + }, + { + "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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager", + "shortName": "list_project_billing_info" + }, + "description": "Sample for ListProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.set_iam_policy", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.SetIamPolicy", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_SetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.set_iam_policy", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.SetIamPolicy", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_SetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.TestIamPermissions", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "MutableSequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_TestIamPermissions_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.TestIamPermissions", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "MutableSequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_TestIamPermissions_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.update_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "UpdateBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.UpdateBillingAccountRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "account", + "type": "google.cloud.billing_v1.types.BillingAccount" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.BillingAccount", + "shortName": "update_billing_account" + }, + "description": "Sample for UpdateBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_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": "cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.update_billing_account", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateBillingAccount", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "UpdateBillingAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.UpdateBillingAccountRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "account", + "type": "google.cloud.billing_v1.types.BillingAccount" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.BillingAccount", + "shortName": "update_billing_account" + }, + "description": "Sample for UpdateBillingAccount", + "file": "cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_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": "cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient", + "shortName": "CloudBillingAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingAsyncClient.update_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "UpdateProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "project_billing_info", + "type": "google.cloud.billing_v1.types.ProjectBillingInfo" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.ProjectBillingInfo", + "shortName": "update_project_billing_info" + }, + "description": "Sample for UpdateProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudBillingClient", + "shortName": "CloudBillingClient" + }, + "fullName": "google.cloud.billing_v1.CloudBillingClient.update_project_billing_info", + "method": { + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateProjectBillingInfo", + "service": { + "fullName": "google.cloud.billing.v1.CloudBilling", + "shortName": "CloudBilling" + }, + "shortName": "UpdateProjectBillingInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "project_billing_info", + "type": "google.cloud.billing_v1.types.ProjectBillingInfo" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.types.ProjectBillingInfo", + "shortName": "update_project_billing_info" + }, + "description": "Sample for UpdateProjectBillingInfo", + "file": "cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_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": "cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudCatalogAsyncClient", + "shortName": "CloudCatalogAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudCatalogAsyncClient.list_services", + "method": { + "fullName": "google.cloud.billing.v1.CloudCatalog.ListServices", + "service": { + "fullName": "google.cloud.billing.v1.CloudCatalog", + "shortName": "CloudCatalog" + }, + "shortName": "ListServices" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListServicesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager", + "shortName": "list_services" + }, + "description": "Sample for ListServices", + "file": "cloudbilling_v1_generated_cloud_catalog_list_services_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListServices_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_catalog_list_services_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudCatalogClient", + "shortName": "CloudCatalogClient" + }, + "fullName": "google.cloud.billing_v1.CloudCatalogClient.list_services", + "method": { + "fullName": "google.cloud.billing.v1.CloudCatalog.ListServices", + "service": { + "fullName": "google.cloud.billing.v1.CloudCatalog", + "shortName": "CloudCatalog" + }, + "shortName": "ListServices" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListServicesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesPager", + "shortName": "list_services" + }, + "description": "Sample for ListServices", + "file": "cloudbilling_v1_generated_cloud_catalog_list_services_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListServices_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudbilling_v1_generated_cloud_catalog_list_services_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.billing_v1.CloudCatalogAsyncClient", + "shortName": "CloudCatalogAsyncClient" + }, + "fullName": "google.cloud.billing_v1.CloudCatalogAsyncClient.list_skus", + "method": { + "fullName": "google.cloud.billing.v1.CloudCatalog.ListSkus", + "service": { + "fullName": "google.cloud.billing.v1.CloudCatalog", + "shortName": "CloudCatalog" + }, + "shortName": "ListSkus" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListSkusRequest" + }, + { + "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.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager", + "shortName": "list_skus" + }, + "description": "Sample for ListSkus", + "file": "cloudbilling_v1_generated_cloud_catalog_list_skus_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListSkus_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": "cloudbilling_v1_generated_cloud_catalog_list_skus_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.billing_v1.CloudCatalogClient", + "shortName": "CloudCatalogClient" + }, + "fullName": "google.cloud.billing_v1.CloudCatalogClient.list_skus", + "method": { + "fullName": "google.cloud.billing.v1.CloudCatalog.ListSkus", + "service": { + "fullName": "google.cloud.billing.v1.CloudCatalog", + "shortName": "CloudCatalog" + }, + "shortName": "ListSkus" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.billing_v1.types.ListSkusRequest" + }, + { + "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.billing_v1.services.cloud_catalog.pagers.ListSkusPager", + "shortName": "list_skus" + }, + "description": "Sample for ListSkus", + "file": "cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListSkus_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": "cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py b/owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py new file mode 100644 index 000000000000..557ca9729200 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py @@ -0,0 +1,187 @@ +#! /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 billingCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_billing_account': ('billing_account', ), + 'get_billing_account': ('name', ), + 'get_iam_policy': ('resource', 'options', ), + 'get_project_billing_info': ('name', ), + 'list_billing_accounts': ('page_size', 'page_token', 'filter', ), + 'list_project_billing_info': ('name', 'page_size', 'page_token', ), + 'list_services': ('page_size', 'page_token', ), + 'list_skus': ('parent', 'start_time', 'end_time', 'currency_code', 'page_size', 'page_token', ), + 'set_iam_policy': ('resource', 'policy', 'update_mask', ), + 'test_iam_permissions': ('resource', 'permissions', ), + 'update_billing_account': ('name', 'account', 'update_mask', ), + 'update_project_billing_info': ('name', 'project_billing_info', ), + } + + 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=billingCallTransformer(), +): + """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 billing client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-cloud-billing/v1/setup.py b/owl-bot-staging/google-cloud-billing/v1/setup.py new file mode 100644 index 000000000000..eec7275f8a68 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/setup.py @@ -0,0 +1,91 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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-billing' + + +description = "Google Cloud Billing API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/billing/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", + "grpc-google-iam-v1 >= 0.12.4, <1.0.0dev", +] +url = "https://github.com/googleapis/python-billing" + +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/google-cloud-billing/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt new file mode 100644 index 000000000000..2beecf99e0be --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt @@ -0,0 +1,10 @@ +# 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 +grpc-google-iam-v1==0.12.4 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/tests/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/__init__.py new file mode 100644 index 000000000000..231bc125017b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/__init__.py new file mode 100644 index 000000000000..231bc125017b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..231bc125017b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py new file mode 100644 index 000000000000..231bc125017b --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py new file mode 100644 index 000000000000..ba1478da6cb2 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py @@ -0,0 +1,6262 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.billing_v1.services.cloud_billing import CloudBillingAsyncClient +from google.cloud.billing_v1.services.cloud_billing import CloudBillingClient +from google.cloud.billing_v1.services.cloud_billing import pagers +from google.cloud.billing_v1.services.cloud_billing import transports +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import options_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.type import expr_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 CloudBillingClient._get_default_mtls_endpoint(None) is None + assert CloudBillingClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert CloudBillingClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert CloudBillingClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert CloudBillingClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert CloudBillingClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (CloudBillingClient, "grpc"), + (CloudBillingAsyncClient, "grpc_asyncio"), + (CloudBillingClient, "rest"), +]) +def test_cloud_billing_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 == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudbilling.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.CloudBillingGrpcTransport, "grpc"), + (transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.CloudBillingRestTransport, "rest"), +]) +def test_cloud_billing_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", [ + (CloudBillingClient, "grpc"), + (CloudBillingAsyncClient, "grpc_asyncio"), + (CloudBillingClient, "rest"), +]) +def test_cloud_billing_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 == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudbilling.googleapis.com' + ) + + +def test_cloud_billing_client_get_transport_class(): + transport = CloudBillingClient.get_transport_class() + available_transports = [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingRestTransport, + ] + assert transport in available_transports + + transport = CloudBillingClient.get_transport_class("grpc") + assert transport == transports.CloudBillingGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), + (CloudBillingClient, transports.CloudBillingRestTransport, "rest"), +]) +@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) +@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) +def test_cloud_billing_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(CloudBillingClient, '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(CloudBillingClient, '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", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", "true"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", "false"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (CloudBillingClient, transports.CloudBillingRestTransport, "rest", "true"), + (CloudBillingClient, transports.CloudBillingRestTransport, "rest", "false"), +]) +@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) +@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_cloud_billing_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", [ + CloudBillingClient, CloudBillingAsyncClient +]) +@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) +@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) +def test_cloud_billing_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", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), + (CloudBillingClient, transports.CloudBillingRestTransport, "rest"), +]) +def test_cloud_billing_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", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", grpc_helpers), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (CloudBillingClient, transports.CloudBillingRestTransport, "rest", None), +]) +def test_cloud_billing_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_cloud_billing_client_client_options_from_dict(): + with mock.patch('google.cloud.billing_v1.services.cloud_billing.transports.CloudBillingGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = CloudBillingClient( + 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", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", grpc_helpers), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_cloud_billing_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( + "cloudbilling.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="cloudbilling.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.GetBillingAccountRequest, + dict, +]) +def test_get_billing_account(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + response = client.get_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_get_billing_account_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 = CloudBillingClient( + 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_billing_account), + '__call__') as call: + client.get_billing_account() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetBillingAccountRequest() + +@pytest.mark.asyncio +async def test_get_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.GetBillingAccountRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + )) + response = await client.get_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +@pytest.mark.asyncio +async def test_get_billing_account_async_from_dict(): + await test_get_billing_account_async(request_type=dict) + + +def test_get_billing_account_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.GetBillingAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_billing_account), + '__call__') as call: + call.return_value = cloud_billing.BillingAccount() + client.get_billing_account(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_billing_account_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.GetBillingAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_billing_account), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) + await client.get_billing_account(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_billing_account_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_billing_account( + 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_billing_account_flattened_error(): + client = CloudBillingClient( + 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_billing_account( + cloud_billing.GetBillingAccountRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_billing_account_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_billing_account( + 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_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_billing_account( + cloud_billing.GetBillingAccountRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.ListBillingAccountsRequest, + dict, +]) +def test_list_billing_accounts(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_accounts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ListBillingAccountsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_billing_accounts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListBillingAccountsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListBillingAccountsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_billing_accounts_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 = CloudBillingClient( + 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_billing_accounts), + '__call__') as call: + client.list_billing_accounts() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListBillingAccountsRequest() + +@pytest.mark.asyncio +async def test_list_billing_accounts_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.ListBillingAccountsRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_accounts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListBillingAccountsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_billing_accounts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListBillingAccountsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListBillingAccountsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_billing_accounts_async_from_dict(): + await test_list_billing_accounts_async(request_type=dict) + + +def test_list_billing_accounts_pager(transport_name: str = "grpc"): + client = CloudBillingClient( + 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_billing_accounts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + next_page_token='abc', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[], + next_page_token='def', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + ], + next_page_token='ghi', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + ), + RuntimeError, + ) + + metadata = () + pager = client.list_billing_accounts(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.BillingAccount) + for i in results) +def test_list_billing_accounts_pages(transport_name: str = "grpc"): + client = CloudBillingClient( + 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_billing_accounts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + next_page_token='abc', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[], + next_page_token='def', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + ], + next_page_token='ghi', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + ), + RuntimeError, + ) + pages = list(client.list_billing_accounts(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_billing_accounts_async_pager(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_billing_accounts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + next_page_token='abc', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[], + next_page_token='def', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + ], + next_page_token='ghi', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_billing_accounts(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_billing.BillingAccount) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_billing_accounts_async_pages(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_billing_accounts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + next_page_token='abc', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[], + next_page_token='def', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + ], + next_page_token='ghi', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_billing_accounts(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_billing.UpdateBillingAccountRequest, + dict, +]) +def test_update_billing_account(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + response = client.update_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_update_billing_account_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 = CloudBillingClient( + 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_billing_account), + '__call__') as call: + client.update_billing_account() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateBillingAccountRequest() + +@pytest.mark.asyncio +async def test_update_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.UpdateBillingAccountRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + )) + response = await client.update_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +@pytest.mark.asyncio +async def test_update_billing_account_async_from_dict(): + await test_update_billing_account_async(request_type=dict) + + +def test_update_billing_account_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.UpdateBillingAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_billing_account), + '__call__') as call: + call.return_value = cloud_billing.BillingAccount() + client.update_billing_account(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_update_billing_account_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.UpdateBillingAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_billing_account), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) + await client.update_billing_account(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_update_billing_account_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_billing_account( + name='name_value', + account=cloud_billing.BillingAccount(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 + arg = args[0].account + mock_val = cloud_billing.BillingAccount(name='name_value') + assert arg == mock_val + + +def test_update_billing_account_flattened_error(): + client = CloudBillingClient( + 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_billing_account( + cloud_billing.UpdateBillingAccountRequest(), + name='name_value', + account=cloud_billing.BillingAccount(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_update_billing_account_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_billing_account( + name='name_value', + account=cloud_billing.BillingAccount(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 + arg = args[0].account + mock_val = cloud_billing.BillingAccount(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_billing_account( + cloud_billing.UpdateBillingAccountRequest(), + name='name_value', + account=cloud_billing.BillingAccount(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.CreateBillingAccountRequest, + dict, +]) +def test_create_billing_account(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + response = client.create_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.CreateBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_create_billing_account_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 = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_billing_account), + '__call__') as call: + client.create_billing_account() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.CreateBillingAccountRequest() + +@pytest.mark.asyncio +async def test_create_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.CreateBillingAccountRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + )) + response = await client.create_billing_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.CreateBillingAccountRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +@pytest.mark.asyncio +async def test_create_billing_account_async_from_dict(): + await test_create_billing_account_async(request_type=dict) + + +def test_create_billing_account_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_billing_account( + billing_account=cloud_billing.BillingAccount(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].billing_account + mock_val = cloud_billing.BillingAccount(name='name_value') + assert arg == mock_val + + +def test_create_billing_account_flattened_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_billing_account( + cloud_billing.CreateBillingAccountRequest(), + billing_account=cloud_billing.BillingAccount(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_billing_account_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_billing_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.BillingAccount() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_billing_account( + billing_account=cloud_billing.BillingAccount(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].billing_account + mock_val = cloud_billing.BillingAccount(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_billing_account( + cloud_billing.CreateBillingAccountRequest(), + billing_account=cloud_billing.BillingAccount(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.ListProjectBillingInfoRequest, + dict, +]) +def test_list_project_billing_info(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ListProjectBillingInfoResponse( + next_page_token='next_page_token_value', + ) + response = client.list_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProjectBillingInfoPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_project_billing_info_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 = CloudBillingClient( + 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_project_billing_info), + '__call__') as call: + client.list_project_billing_info() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListProjectBillingInfoRequest() + +@pytest.mark.asyncio +async def test_list_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.ListProjectBillingInfoRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.ListProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProjectBillingInfoAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_project_billing_info_async_from_dict(): + await test_list_project_billing_info_async(request_type=dict) + + +def test_list_project_billing_info_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.ListProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__') as call: + call.return_value = cloud_billing.ListProjectBillingInfoResponse() + client.list_project_billing_info(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_list_project_billing_info_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.ListProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse()) + await client.list_project_billing_info(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_list_project_billing_info_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ListProjectBillingInfoResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_project_billing_info( + 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_list_project_billing_info_flattened_error(): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.ListProjectBillingInfoRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_list_project_billing_info_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ListProjectBillingInfoResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_project_billing_info( + 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_list_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_project_billing_info( + cloud_billing.ListProjectBillingInfoRequest(), + name='name_value', + ) + + +def test_list_project_billing_info_pager(transport_name: str = "grpc"): + client = CloudBillingClient( + 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_project_billing_info), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='abc', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[], + next_page_token='def', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='ghi', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', ''), + )), + ) + pager = client.list_project_billing_info(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.ProjectBillingInfo) + for i in results) +def test_list_project_billing_info_pages(transport_name: str = "grpc"): + client = CloudBillingClient( + 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_project_billing_info), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='abc', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[], + next_page_token='def', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='ghi', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + ), + RuntimeError, + ) + pages = list(client.list_project_billing_info(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_project_billing_info_async_pager(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='abc', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[], + next_page_token='def', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='ghi', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_project_billing_info(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_billing.ProjectBillingInfo) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_project_billing_info_async_pages(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_project_billing_info), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='abc', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[], + next_page_token='def', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='ghi', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_project_billing_info(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_billing.GetProjectBillingInfoRequest, + dict, +]) +def test_get_project_billing_info(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + ) + response = client.get_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +def test_get_project_billing_info_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 = CloudBillingClient( + 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_project_billing_info), + '__call__') as call: + client.get_project_billing_info() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetProjectBillingInfoRequest() + +@pytest.mark.asyncio +async def test_get_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.GetProjectBillingInfoRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + )) + response = await client.get_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.GetProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +@pytest.mark.asyncio +async def test_get_project_billing_info_async_from_dict(): + await test_get_project_billing_info_async(request_type=dict) + + +def test_get_project_billing_info_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.GetProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_project_billing_info), + '__call__') as call: + call.return_value = cloud_billing.ProjectBillingInfo() + client.get_project_billing_info(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_project_billing_info_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.GetProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_project_billing_info), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) + await client.get_project_billing_info(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_project_billing_info_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_project_billing_info( + 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_project_billing_info_flattened_error(): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.GetProjectBillingInfoRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_project_billing_info_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_project_billing_info( + 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_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_project_billing_info( + cloud_billing.GetProjectBillingInfoRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.UpdateProjectBillingInfoRequest, + dict, +]) +def test_update_project_billing_info(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + ) + response = client.update_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +def test_update_project_billing_info_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 = CloudBillingClient( + 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_project_billing_info), + '__call__') as call: + client.update_project_billing_info() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() + +@pytest.mark.asyncio +async def test_update_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.UpdateProjectBillingInfoRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + )) + response = await client.update_project_billing_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +@pytest.mark.asyncio +async def test_update_project_billing_info_async_from_dict(): + await test_update_project_billing_info_async(request_type=dict) + + +def test_update_project_billing_info_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.UpdateProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_project_billing_info), + '__call__') as call: + call.return_value = cloud_billing.ProjectBillingInfo() + client.update_project_billing_info(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_update_project_billing_info_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_billing.UpdateProjectBillingInfoRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_project_billing_info), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) + await client.update_project_billing_info(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_update_project_billing_info_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_project_billing_info( + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(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 + arg = args[0].project_billing_info + mock_val = cloud_billing.ProjectBillingInfo(name='name_value') + assert arg == mock_val + + +def test_update_project_billing_info_flattened_error(): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.UpdateProjectBillingInfoRequest(), + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_update_project_billing_info_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_project_billing_info), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_billing.ProjectBillingInfo() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_project_billing_info( + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(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 + arg = args[0].project_billing_info + mock_val = cloud_billing.ProjectBillingInfo(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_project_billing_info( + cloud_billing.UpdateProjectBillingInfoRequest(), + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.GetIamPolicyRequest, + dict, +]) +def test_get_iam_policy(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_get_iam_policy_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 = CloudBillingClient( + 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_iam_policy), + '__call__') as call: + client.get_iam_policy() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + +@pytest.mark.asyncio +async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_get_iam_policy_async_from_dict(): + await test_get_iam_policy_async(request_type=dict) + + +def test_get_iam_policy_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_iam_policy_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + +def test_get_iam_policy_from_dict_foreign(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.get_iam_policy(request={ + 'resource': 'resource_value', + 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), + } + ) + call.assert_called() + + +def test_get_iam_policy_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_iam_policy( + resource='resource_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + + +def test_get_iam_policy_flattened_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_iam_policy( + resource='resource_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_error_async(): + client = CloudBillingAsyncClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.SetIamPolicyRequest, + dict, +]) +def test_set_iam_policy(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_set_iam_policy_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 = CloudBillingClient( + 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.set_iam_policy), + '__call__') as call: + client.set_iam_policy() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + +@pytest.mark.asyncio +async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_set_iam_policy_async_from_dict(): + await test_set_iam_policy_async(request_type=dict) + + +def test_set_iam_policy_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_iam_policy_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + +def test_set_iam_policy_from_dict_foreign(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.set_iam_policy(request={ + 'resource': 'resource_value', + 'policy': policy_pb2.Policy(version=774), + 'update_mask': field_mask_pb2.FieldMask(paths=['paths_value']), + } + ) + call.assert_called() + + +def test_set_iam_policy_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.set_iam_policy( + resource='resource_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + + +def test_set_iam_policy_flattened_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.set_iam_policy( + resource='resource_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_error_async(): + client = CloudBillingAsyncClient( + 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.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, +]) +def test_test_iam_permissions(request_type, transport: str = 'grpc'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + ) + response = client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +def test_test_iam_permissions_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 = CloudBillingClient( + 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.test_iam_permissions), + '__call__') as call: + client.test_iam_permissions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + +@pytest.mark.asyncio +async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + )) + response = await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_async_from_dict(): + await test_test_iam_permissions_async(request_type=dict) + + +def test_test_iam_permissions_field_headers(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_field_headers_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) + await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + +def test_test_iam_permissions_from_dict_foreign(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + response = client.test_iam_permissions(request={ + 'resource': 'resource_value', + 'permissions': ['permissions_value'], + } + ) + call.assert_called() + + +def test_test_iam_permissions_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.test_iam_permissions( + resource='resource_value', + permissions=['permissions_value'], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + arg = args[0].permissions + mock_val = ['permissions_value'] + assert arg == mock_val + + +def test_test_iam_permissions_flattened_error(): + client = CloudBillingClient( + 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.test_iam_permissions( + iam_policy_pb2.TestIamPermissionsRequest(), + resource='resource_value', + permissions=['permissions_value'], + ) + +@pytest.mark.asyncio +async def test_test_iam_permissions_flattened_async(): + client = CloudBillingAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.test_iam_permissions( + resource='resource_value', + permissions=['permissions_value'], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = 'resource_value' + assert arg == mock_val + arg = args[0].permissions + mock_val = ['permissions_value'] + assert arg == mock_val + +@pytest.mark.asyncio +async def test_test_iam_permissions_flattened_error_async(): + client = CloudBillingAsyncClient( + 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.test_iam_permissions( + iam_policy_pb2.TestIamPermissionsRequest(), + resource='resource_value', + permissions=['permissions_value'], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.GetBillingAccountRequest, + dict, +]) +def test_get_billing_account_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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_billing_account(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_get_billing_account_rest_required_fields(request_type=cloud_billing.GetBillingAccountRequest): + transport_class = transports.CloudBillingRestTransport + + 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_billing_account._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_billing_account._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 = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_billing.BillingAccount.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_billing_account(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_billing_account_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_billing_account._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_billing_account_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_billing_account") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_billing_account") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.GetBillingAccountRequest.pb(cloud_billing.GetBillingAccountRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) + + request = cloud_billing.GetBillingAccountRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.BillingAccount() + + client.get_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.GetBillingAccountRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + 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_billing_account(request) + + +def test_get_billing_account_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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_billing_account(**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=billingAccounts/*}" % client.transport._host, args[1]) + + +def test_get_billing_account_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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_billing_account( + cloud_billing.GetBillingAccountRequest(), + name='name_value', + ) + + +def test_get_billing_account_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.ListBillingAccountsRequest, + dict, +]) +def test_list_billing_accounts_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ListBillingAccountsResponse( + 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 = cloud_billing.ListBillingAccountsResponse.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_billing_accounts(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListBillingAccountsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_billing_accounts_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_list_billing_accounts") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_list_billing_accounts") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.ListBillingAccountsRequest.pb(cloud_billing.ListBillingAccountsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.ListBillingAccountsResponse.to_json(cloud_billing.ListBillingAccountsResponse()) + + request = cloud_billing.ListBillingAccountsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.ListBillingAccountsResponse() + + client.list_billing_accounts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_billing_accounts_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.ListBillingAccountsRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + 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_billing_accounts(request) + + +def test_list_billing_accounts_rest_pager(transport: str = 'rest'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + next_page_token='abc', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[], + next_page_token='def', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + ], + next_page_token='ghi', + ), + cloud_billing.ListBillingAccountsResponse( + billing_accounts=[ + cloud_billing.BillingAccount(), + cloud_billing.BillingAccount(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_billing.ListBillingAccountsResponse.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 = {} + + pager = client.list_billing_accounts(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.BillingAccount) + for i in results) + + pages = list(client.list_billing_accounts(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.UpdateBillingAccountRequest, + dict, +]) +def test_update_billing_account_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + request_init["account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_update_billing_account_rest_required_fields(request_type=cloud_billing.UpdateBillingAccountRequest): + transport_class = transports.CloudBillingRestTransport + + 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()).update_billing_account._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()).update_billing_account._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 + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + # 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 + + pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_billing_account_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_billing_account._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("name", "account", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_billing_account_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_update_billing_account") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_update_billing_account") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.UpdateBillingAccountRequest.pb(cloud_billing.UpdateBillingAccountRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) + + request = cloud_billing.UpdateBillingAccountRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.BillingAccount() + + client.update_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.UpdateBillingAccountRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + request_init["account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_billing_account(request) + + +def test_update_billing_account_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + account=cloud_billing.BillingAccount(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(**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=billingAccounts/*}" % client.transport._host, args[1]) + + +def test_update_billing_account_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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_billing_account( + cloud_billing.UpdateBillingAccountRequest(), + name='name_value', + account=cloud_billing.BillingAccount(name='name_value'), + ) + + +def test_update_billing_account_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.CreateBillingAccountRequest, + dict, +]) +def test_create_billing_account_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request_init["billing_account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount( + name='name_value', + open_=True, + display_name='display_name_value', + master_billing_account='master_billing_account_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.BillingAccount) + assert response.name == 'name_value' + assert response.open_ is True + assert response.display_name == 'display_name_value' + assert response.master_billing_account == 'master_billing_account_value' + + +def test_create_billing_account_rest_required_fields(request_type=cloud_billing.CreateBillingAccountRequest): + transport_class = transports.CloudBillingRestTransport + + 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()).create_billing_account._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()).create_billing_account._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_billing_account_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_billing_account._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("billingAccount", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_billing_account_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_create_billing_account") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_create_billing_account") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.CreateBillingAccountRequest.pb(cloud_billing.CreateBillingAccountRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) + + request = cloud_billing.CreateBillingAccountRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.BillingAccount() + + client.create_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.CreateBillingAccountRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request_init["billing_account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_billing_account(request) + + +def test_create_billing_account_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.BillingAccount() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + billing_account=cloud_billing.BillingAccount(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(**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/billingAccounts" % client.transport._host, args[1]) + + +def test_create_billing_account_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_billing_account( + cloud_billing.CreateBillingAccountRequest(), + billing_account=cloud_billing.BillingAccount(name='name_value'), + ) + + +def test_create_billing_account_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.ListProjectBillingInfoRequest, + dict, +]) +def test_list_project_billing_info_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ListProjectBillingInfoResponse( + 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 = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListProjectBillingInfoPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_project_billing_info_rest_required_fields(request_type=cloud_billing.ListProjectBillingInfoRequest): + transport_class = transports.CloudBillingRestTransport + + 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()).list_project_billing_info._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()).list_project_billing_info._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ListProjectBillingInfoResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_project_billing_info_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_project_billing_info._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_project_billing_info_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_list_project_billing_info") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_list_project_billing_info") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.ListProjectBillingInfoRequest.pb(cloud_billing.ListProjectBillingInfoRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.ListProjectBillingInfoResponse.to_json(cloud_billing.ListProjectBillingInfoResponse()) + + request = cloud_billing.ListProjectBillingInfoRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.ListProjectBillingInfoResponse() + + client.list_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.ListProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'billingAccounts/sample1'} + 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_project_billing_info(request) + + +def test_list_project_billing_info_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ListProjectBillingInfoResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(**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=billingAccounts/*}/projects" % client.transport._host, args[1]) + + +def test_list_project_billing_info_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.ListProjectBillingInfoRequest(), + name='name_value', + ) + + +def test_list_project_billing_info_rest_pager(transport: str = 'rest'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='abc', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[], + next_page_token='def', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + ], + next_page_token='ghi', + ), + cloud_billing.ListProjectBillingInfoResponse( + project_billing_info=[ + cloud_billing.ProjectBillingInfo(), + cloud_billing.ProjectBillingInfo(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_billing.ListProjectBillingInfoResponse.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 = {'name': 'billingAccounts/sample1'} + + pager = client.list_project_billing_info(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.ProjectBillingInfo) + for i in results) + + pages = list(client.list_project_billing_info(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.GetProjectBillingInfoRequest, + dict, +]) +def test_get_project_billing_info_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +def test_get_project_billing_info_rest_required_fields(request_type=cloud_billing.GetProjectBillingInfoRequest): + transport_class = transports.CloudBillingRestTransport + + 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_project_billing_info._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_project_billing_info._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 = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_project_billing_info_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_project_billing_info._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_project_billing_info_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_project_billing_info") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_project_billing_info") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.GetProjectBillingInfoRequest.pb(cloud_billing.GetProjectBillingInfoRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.ProjectBillingInfo.to_json(cloud_billing.ProjectBillingInfo()) + + request = cloud_billing.GetProjectBillingInfoRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.ProjectBillingInfo() + + client.get_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.GetProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1'} + 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_project_billing_info(request) + + +def test_get_project_billing_info_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(**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/*}/billingInfo" % client.transport._host, args[1]) + + +def test_get_project_billing_info_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.GetProjectBillingInfoRequest(), + name='name_value', + ) + + +def test_get_project_billing_info_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_billing.UpdateProjectBillingInfoRequest, + dict, +]) +def test_update_project_billing_info_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1'} + request_init["project_billing_info"] = {'name': 'name_value', 'project_id': 'project_id_value', 'billing_account_name': 'billing_account_name_value', 'billing_enabled': True} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo( + name='name_value', + project_id='project_id_value', + billing_account_name='billing_account_name_value', + billing_enabled=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_billing.ProjectBillingInfo) + assert response.name == 'name_value' + assert response.project_id == 'project_id_value' + assert response.billing_account_name == 'billing_account_name_value' + assert response.billing_enabled is True + + +def test_update_project_billing_info_rest_required_fields(request_type=cloud_billing.UpdateProjectBillingInfoRequest): + transport_class = transports.CloudBillingRestTransport + + 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()).update_project_billing_info._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()).update_project_billing_info._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 = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo() + # 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': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_project_billing_info_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_project_billing_info._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_project_billing_info_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_update_project_billing_info") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_update_project_billing_info") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_billing.UpdateProjectBillingInfoRequest.pb(cloud_billing.UpdateProjectBillingInfoRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_billing.ProjectBillingInfo.to_json(cloud_billing.ProjectBillingInfo()) + + request = cloud_billing.UpdateProjectBillingInfoRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_billing.ProjectBillingInfo() + + client.update_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.UpdateProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1'} + request_init["project_billing_info"] = {'name': 'name_value', 'project_id': 'project_id_value', 'billing_account_name': 'billing_account_name_value', 'billing_enabled': True} + 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_project_billing_info(request) + + +def test_update_project_billing_info_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_billing.ProjectBillingInfo() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(**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/*}/billingInfo" % client.transport._host, args[1]) + + +def test_update_project_billing_info_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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_project_billing_info( + cloud_billing.UpdateProjectBillingInfoRequest(), + name='name_value', + project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), + ) + + +def test_update_project_billing_info_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.GetIamPolicyRequest, + dict, +]) +def test_get_iam_policy_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_get_iam_policy_rest_required_fields(request_type=iam_policy_pb2.GetIamPolicyRequest): + transport_class = transports.CloudBillingRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = 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_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("options", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = 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_iam_policy(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_iam_policy_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(("options", )) & set(("resource", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_iam_policy_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_iam_policy") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_iam_policy") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.GetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) + + request = iam_policy_pb2.GetIamPolicyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + + client.get_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_iam_policy_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.GetIamPolicyRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + 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_iam_policy(request) + + +def test_get_iam_policy_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = {'resource': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + resource='resource_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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_iam_policy(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{resource=billingAccounts/*}:getIamPolicy" % client.transport._host, args[1]) + + +def test_get_iam_policy_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_get_iam_policy_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.SetIamPolicyRequest, + dict, +]) +def test_set_iam_policy_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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.set_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_set_iam_policy_rest_required_fields(request_type=iam_policy_pb2.SetIamPolicyRequest): + transport_class = transports.CloudBillingRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = 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()).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = 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.set_iam_policy(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_iam_policy_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("resource", "policy", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_iam_policy_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_set_iam_policy") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_set_iam_policy") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.SetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) + + request = iam_policy_pb2.SetIamPolicyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + + client.set_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_iam_policy_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.SetIamPolicyRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + 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.set_iam_policy(request) + + +def test_set_iam_policy_rest_flattened(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = {'resource': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + resource='resource_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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.set_iam_policy(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{resource=billingAccounts/*}:setIamPolicy" % client.transport._host, args[1]) + + +def test_set_iam_policy_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_set_iam_policy_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, +]) +def test_test_iam_permissions_rest(request_type): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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.test_iam_permissions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +def test_test_iam_permissions_rest_required_fields(request_type=iam_policy_pb2.TestIamPermissionsRequest): + transport_class = transports.CloudBillingRestTransport + + request_init = {} + request_init["resource"] = "" + request_init["permissions"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + 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()).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + jsonified_request["permissions"] = 'permissions_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + assert "permissions" in jsonified_request + assert jsonified_request["permissions"] == 'permissions_value' + + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = 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.test_iam_permissions(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_test_iam_permissions_rest_unset_required_fields(): + transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("resource", "permissions", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_test_iam_permissions_rest_interceptors(null_interceptor): + transport = transports.CloudBillingRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), + ) + client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_test_iam_permissions") as post, \ + mock.patch.object(transports.CloudBillingRestInterceptor, "pre_test_iam_permissions") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.TestIamPermissionsRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(iam_policy_pb2.TestIamPermissionsResponse()) + + request = iam_policy_pb2.TestIamPermissionsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = iam_policy_pb2.TestIamPermissionsResponse() + + client.test_iam_permissions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_test_iam_permissions_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'billingAccounts/sample1'} + 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.test_iam_permissions(request) + + +def test_test_iam_permissions_rest_flattened(): + client = CloudBillingClient( + 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 = iam_policy_pb2.TestIamPermissionsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'resource': 'billingAccounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + resource='resource_value', + permissions=['permissions_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 = 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.test_iam_permissions(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{resource=billingAccounts/*}:testIamPermissions" % client.transport._host, args[1]) + + +def test_test_iam_permissions_rest_flattened_error(transport: str = 'rest'): + client = CloudBillingClient( + 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.test_iam_permissions( + iam_policy_pb2.TestIamPermissionsRequest(), + resource='resource_value', + permissions=['permissions_value'], + ) + + +def test_test_iam_permissions_rest_error(): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudBillingClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CloudBillingClient( + 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 = CloudBillingClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudBillingClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = CloudBillingClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CloudBillingGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, + transports.CloudBillingRestTransport, +]) +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 = CloudBillingClient.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 = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.CloudBillingGrpcTransport, + ) + +def test_cloud_billing_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.CloudBillingTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_cloud_billing_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.billing_v1.services.cloud_billing.transports.CloudBillingTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.CloudBillingTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'get_billing_account', + 'list_billing_accounts', + 'update_billing_account', + 'create_billing_account', + 'list_project_billing_info', + 'get_project_billing_info', + 'update_project_billing_info', + 'get_iam_policy', + 'set_iam_policy', + 'test_iam_permissions', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_cloud_billing_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.billing_v1.services.cloud_billing.transports.CloudBillingTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudBillingTransport( + 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-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_cloud_billing_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.billing_v1.services.cloud_billing.transports.CloudBillingTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudBillingTransport() + adc.assert_called_once() + + +def test_cloud_billing_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) + CloudBillingClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, + ], +) +def test_cloud_billing_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-billing', 'https://www.googleapis.com/auth/cloud-billing.readonly', 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, + transports.CloudBillingRestTransport, + ], +) +def test_cloud_billing_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.CloudBillingGrpcTransport, grpc_helpers), + (transports.CloudBillingGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_cloud_billing_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( + "cloudbilling.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="cloudbilling.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) +def test_cloud_billing_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_cloud_billing_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.CloudBillingRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_cloud_billing_host_no_port(transport_name): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudbilling.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_cloud_billing_host_with_port(transport_name): + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudbilling.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudbilling.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_cloud_billing_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = CloudBillingClient( + credentials=creds1, + transport=transport_name, + ) + client2 = CloudBillingClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.get_billing_account._session + session2 = client2.transport.get_billing_account._session + assert session1 != session2 + session1 = client1.transport.list_billing_accounts._session + session2 = client2.transport.list_billing_accounts._session + assert session1 != session2 + session1 = client1.transport.update_billing_account._session + session2 = client2.transport.update_billing_account._session + assert session1 != session2 + session1 = client1.transport.create_billing_account._session + session2 = client2.transport.create_billing_account._session + assert session1 != session2 + session1 = client1.transport.list_project_billing_info._session + session2 = client2.transport.list_project_billing_info._session + assert session1 != session2 + session1 = client1.transport.get_project_billing_info._session + session2 = client2.transport.get_project_billing_info._session + assert session1 != session2 + session1 = client1.transport.update_project_billing_info._session + session2 = client2.transport.update_project_billing_info._session + assert session1 != session2 + session1 = client1.transport.get_iam_policy._session + session2 = client2.transport.get_iam_policy._session + assert session1 != session2 + session1 = client1.transport.set_iam_policy._session + session2 = client2.transport.set_iam_policy._session + assert session1 != session2 + session1 = client1.transport.test_iam_permissions._session + session2 = client2.transport.test_iam_permissions._session + assert session1 != session2 +def test_cloud_billing_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudBillingGrpcTransport( + 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_cloud_billing_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudBillingGrpcAsyncIOTransport( + 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.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) +def test_cloud_billing_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.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) +def test_cloud_billing_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_project_billing_info_path(): + project = "squid" + expected = "projects/{project}/billingInfo".format(project=project, ) + actual = CloudBillingClient.project_billing_info_path(project) + assert expected == actual + + +def test_parse_project_billing_info_path(): + expected = { + "project": "clam", + } + path = CloudBillingClient.project_billing_info_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_project_billing_info_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = CloudBillingClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = CloudBillingClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format(folder=folder, ) + actual = CloudBillingClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = CloudBillingClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format(organization=organization, ) + actual = CloudBillingClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = CloudBillingClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format(project=project, ) + actual = CloudBillingClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = CloudBillingClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = CloudBillingClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = CloudBillingClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.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.CloudBillingTransport, '_prep_wrapped_messages') as prep: + client = CloudBillingClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.CloudBillingTransport, '_prep_wrapped_messages') as prep: + transport_class = CloudBillingClient.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 = CloudBillingAsyncClient( + 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 = CloudBillingClient( + 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 = CloudBillingClient( + 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", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport), +]) +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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py new file mode 100644 index 000000000000..dc54820e7912 --- /dev/null +++ b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py @@ -0,0 +1,2385 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.billing_v1.services.cloud_catalog import CloudCatalogAsyncClient +from google.cloud.billing_v1.services.cloud_catalog import CloudCatalogClient +from google.cloud.billing_v1.services.cloud_catalog import pagers +from google.cloud.billing_v1.services.cloud_catalog import transports +from google.cloud.billing_v1.types import cloud_catalog +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert CloudCatalogClient._get_default_mtls_endpoint(None) is None + assert CloudCatalogClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert CloudCatalogClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert CloudCatalogClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert CloudCatalogClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert CloudCatalogClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (CloudCatalogClient, "grpc"), + (CloudCatalogAsyncClient, "grpc_asyncio"), + (CloudCatalogClient, "rest"), +]) +def test_cloud_catalog_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 == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudbilling.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.CloudCatalogGrpcTransport, "grpc"), + (transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.CloudCatalogRestTransport, "rest"), +]) +def test_cloud_catalog_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", [ + (CloudCatalogClient, "grpc"), + (CloudCatalogAsyncClient, "grpc_asyncio"), + (CloudCatalogClient, "rest"), +]) +def test_cloud_catalog_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 == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudbilling.googleapis.com' + ) + + +def test_cloud_catalog_client_get_transport_class(): + transport = CloudCatalogClient.get_transport_class() + available_transports = [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogRestTransport, + ] + assert transport in available_transports + + transport = CloudCatalogClient.get_transport_class("grpc") + assert transport == transports.CloudCatalogGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest"), +]) +@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) +@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) +def test_cloud_catalog_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(CloudCatalogClient, '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(CloudCatalogClient, '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", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", "true"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", "false"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", "true"), + (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", "false"), +]) +@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) +@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_cloud_catalog_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", [ + CloudCatalogClient, CloudCatalogAsyncClient +]) +@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) +@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) +def test_cloud_catalog_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", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest"), +]) +def test_cloud_catalog_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", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", grpc_helpers), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", None), +]) +def test_cloud_catalog_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_cloud_catalog_client_client_options_from_dict(): + with mock.patch('google.cloud.billing_v1.services.cloud_catalog.transports.CloudCatalogGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = CloudCatalogClient( + 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", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", grpc_helpers), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_cloud_catalog_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( + "cloudbilling.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="cloudbilling.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_catalog.ListServicesRequest, + dict, +]) +def test_list_services(request_type, transport: str = 'grpc'): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_services), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_catalog.ListServicesResponse( + next_page_token='next_page_token_value', + ) + response = client.list_services(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListServicesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListServicesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_services_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 = CloudCatalogClient( + 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_services), + '__call__') as call: + client.list_services() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListServicesRequest() + +@pytest.mark.asyncio +async def test_list_services_async(transport: str = 'grpc_asyncio', request_type=cloud_catalog.ListServicesRequest): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_services), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListServicesResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_services(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListServicesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListServicesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_services_async_from_dict(): + await test_list_services_async(request_type=dict) + + +def test_list_services_pager(transport_name: str = "grpc"): + client = CloudCatalogClient( + 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_services), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + next_page_token='abc', + ), + cloud_catalog.ListServicesResponse( + services=[], + next_page_token='def', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + ), + RuntimeError, + ) + + metadata = () + pager = client.list_services(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Service) + for i in results) +def test_list_services_pages(transport_name: str = "grpc"): + client = CloudCatalogClient( + 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_services), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + next_page_token='abc', + ), + cloud_catalog.ListServicesResponse( + services=[], + next_page_token='def', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + ), + RuntimeError, + ) + pages = list(client.list_services(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_services_async_pager(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_services), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + next_page_token='abc', + ), + cloud_catalog.ListServicesResponse( + services=[], + next_page_token='def', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_services(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_catalog.Service) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_services_async_pages(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_services), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + next_page_token='abc', + ), + cloud_catalog.ListServicesResponse( + services=[], + next_page_token='def', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_services(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_catalog.ListSkusRequest, + dict, +]) +def test_list_skus(request_type, transport: str = 'grpc'): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_skus), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_catalog.ListSkusResponse( + next_page_token='next_page_token_value', + ) + response = client.list_skus(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListSkusRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSkusPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_skus_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 = CloudCatalogClient( + 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_skus), + '__call__') as call: + client.list_skus() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListSkusRequest() + +@pytest.mark.asyncio +async def test_list_skus_async(transport: str = 'grpc_asyncio', request_type=cloud_catalog.ListSkusRequest): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_skus), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_skus(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_catalog.ListSkusRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSkusAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_skus_async_from_dict(): + await test_list_skus_async(request_type=dict) + + +def test_list_skus_field_headers(): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_catalog.ListSkusRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__') as call: + call.return_value = cloud_catalog.ListSkusResponse() + client.list_skus(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_skus_field_headers_async(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_catalog.ListSkusRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse()) + await client.list_skus(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_skus_flattened(): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_catalog.ListSkusResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_skus( + 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_skus_flattened_error(): + client = CloudCatalogClient( + 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_skus( + cloud_catalog.ListSkusRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_skus_flattened_async(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_catalog.ListSkusResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_skus( + 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_skus_flattened_error_async(): + client = CloudCatalogAsyncClient( + 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_skus( + cloud_catalog.ListSkusRequest(), + parent='parent_value', + ) + + +def test_list_skus_pager(transport_name: str = "grpc"): + client = CloudCatalogClient( + 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_skus), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + next_page_token='abc', + ), + cloud_catalog.ListSkusResponse( + skus=[], + next_page_token='def', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_skus(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Sku) + for i in results) +def test_list_skus_pages(transport_name: str = "grpc"): + client = CloudCatalogClient( + 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_skus), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + next_page_token='abc', + ), + cloud_catalog.ListSkusResponse( + skus=[], + next_page_token='def', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + ), + RuntimeError, + ) + pages = list(client.list_skus(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_skus_async_pager(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + next_page_token='abc', + ), + cloud_catalog.ListSkusResponse( + skus=[], + next_page_token='def', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_skus(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_catalog.Sku) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_skus_async_pages(): + client = CloudCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_skus), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + next_page_token='abc', + ), + cloud_catalog.ListSkusResponse( + skus=[], + next_page_token='def', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_skus(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_catalog.ListServicesRequest, + dict, +]) +def test_list_services_rest(request_type): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_catalog.ListServicesResponse( + 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 = cloud_catalog.ListServicesResponse.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_services(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListServicesPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_services_rest_interceptors(null_interceptor): + transport = transports.CloudCatalogRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudCatalogRestInterceptor(), + ) + client = CloudCatalogClient(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.CloudCatalogRestInterceptor, "post_list_services") as post, \ + mock.patch.object(transports.CloudCatalogRestInterceptor, "pre_list_services") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_catalog.ListServicesRequest.pb(cloud_catalog.ListServicesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_catalog.ListServicesResponse.to_json(cloud_catalog.ListServicesResponse()) + + request = cloud_catalog.ListServicesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_catalog.ListServicesResponse() + + client.list_services(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_services_rest_bad_request(transport: str = 'rest', request_type=cloud_catalog.ListServicesRequest): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + 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_services(request) + + +def test_list_services_rest_pager(transport: str = 'rest'): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + next_page_token='abc', + ), + cloud_catalog.ListServicesResponse( + services=[], + next_page_token='def', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListServicesResponse( + services=[ + cloud_catalog.Service(), + cloud_catalog.Service(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_catalog.ListServicesResponse.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 = {} + + pager = client.list_services(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Service) + for i in results) + + pages = list(client.list_services(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_catalog.ListSkusRequest, + dict, +]) +def test_list_skus_rest(request_type): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'services/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_catalog.ListSkusResponse( + 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 = cloud_catalog.ListSkusResponse.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_skus(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSkusPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_skus_rest_required_fields(request_type=cloud_catalog.ListSkusRequest): + transport_class = transports.CloudCatalogRestTransport + + 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_skus._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_skus._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("currency_code", "end_time", "page_size", "page_token", "start_time", )) + 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 = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_catalog.ListSkusResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_catalog.ListSkusResponse.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_skus(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_skus_rest_unset_required_fields(): + transport = transports.CloudCatalogRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_skus._get_unset_required_fields({}) + assert set(unset_fields) == (set(("currencyCode", "endTime", "pageSize", "pageToken", "startTime", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_skus_rest_interceptors(null_interceptor): + transport = transports.CloudCatalogRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.CloudCatalogRestInterceptor(), + ) + client = CloudCatalogClient(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.CloudCatalogRestInterceptor, "post_list_skus") as post, \ + mock.patch.object(transports.CloudCatalogRestInterceptor, "pre_list_skus") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_catalog.ListSkusRequest.pb(cloud_catalog.ListSkusRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_catalog.ListSkusResponse.to_json(cloud_catalog.ListSkusResponse()) + + request = cloud_catalog.ListSkusRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_catalog.ListSkusResponse() + + client.list_skus(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_skus_rest_bad_request(transport: str = 'rest', request_type=cloud_catalog.ListSkusRequest): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'services/sample1'} + 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_skus(request) + + +def test_list_skus_rest_flattened(): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_catalog.ListSkusResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'services/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_catalog.ListSkusResponse.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_skus(**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=services/*}/skus" % client.transport._host, args[1]) + + +def test_list_skus_rest_flattened_error(transport: str = 'rest'): + client = CloudCatalogClient( + 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_skus( + cloud_catalog.ListSkusRequest(), + parent='parent_value', + ) + + +def test_list_skus_rest_pager(transport: str = 'rest'): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + next_page_token='abc', + ), + cloud_catalog.ListSkusResponse( + skus=[], + next_page_token='def', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + ], + next_page_token='ghi', + ), + cloud_catalog.ListSkusResponse( + skus=[ + cloud_catalog.Sku(), + cloud_catalog.Sku(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_catalog.ListSkusResponse.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': 'services/sample1'} + + pager = client.list_skus(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Sku) + for i in results) + + pages = list(client.list_skus(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudCatalogClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CloudCatalogClient( + 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 = CloudCatalogClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudCatalogClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = CloudCatalogClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CloudCatalogGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, + transports.CloudCatalogRestTransport, +]) +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 = CloudCatalogClient.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 = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.CloudCatalogGrpcTransport, + ) + +def test_cloud_catalog_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.CloudCatalogTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_cloud_catalog_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.CloudCatalogTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_services', + 'list_skus', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_cloud_catalog_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.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudCatalogTransport( + 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-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_cloud_catalog_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.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudCatalogTransport() + adc.assert_called_once() + + +def test_cloud_catalog_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) + CloudCatalogClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, + ], +) +def test_cloud_catalog_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-billing', 'https://www.googleapis.com/auth/cloud-billing.readonly', 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, + transports.CloudCatalogRestTransport, + ], +) +def test_cloud_catalog_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.CloudCatalogGrpcTransport, grpc_helpers), + (transports.CloudCatalogGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_cloud_catalog_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( + "cloudbilling.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-billing', + 'https://www.googleapis.com/auth/cloud-billing.readonly', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="cloudbilling.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) +def test_cloud_catalog_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_cloud_catalog_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.CloudCatalogRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_cloud_catalog_host_no_port(transport_name): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudbilling.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudbilling.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_cloud_catalog_host_with_port(transport_name): + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudbilling.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudbilling.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_cloud_catalog_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = CloudCatalogClient( + credentials=creds1, + transport=transport_name, + ) + client2 = CloudCatalogClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_services._session + session2 = client2.transport.list_services._session + assert session1 != session2 + session1 = client1.transport.list_skus._session + session2 = client2.transport.list_skus._session + assert session1 != session2 +def test_cloud_catalog_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudCatalogGrpcTransport( + 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_cloud_catalog_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudCatalogGrpcAsyncIOTransport( + 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.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) +def test_cloud_catalog_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.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) +def test_cloud_catalog_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_service_path(): + service = "squid" + expected = "services/{service}".format(service=service, ) + actual = CloudCatalogClient.service_path(service) + assert expected == actual + + +def test_parse_service_path(): + expected = { + "service": "clam", + } + path = CloudCatalogClient.service_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.parse_service_path(path) + assert expected == actual + +def test_sku_path(): + service = "whelk" + sku = "octopus" + expected = "services/{service}/skus/{sku}".format(service=service, sku=sku, ) + actual = CloudCatalogClient.sku_path(service, sku) + assert expected == actual + + +def test_parse_sku_path(): + expected = { + "service": "oyster", + "sku": "nudibranch", + } + path = CloudCatalogClient.sku_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.parse_sku_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = CloudCatalogClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = CloudCatalogClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = CloudCatalogClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = CloudCatalogClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = CloudCatalogClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = CloudCatalogClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = CloudCatalogClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = CloudCatalogClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.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 = CloudCatalogClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = CloudCatalogClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = CloudCatalogClient.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.CloudCatalogTransport, '_prep_wrapped_messages') as prep: + client = CloudCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.CloudCatalogTransport, '_prep_wrapped_messages') as prep: + transport_class = CloudCatalogClient.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 = CloudCatalogAsyncClient( + 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 = CloudCatalogClient( + 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 = CloudCatalogClient( + 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", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport), +]) +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 fed231b8fc1d081de16460b103f5c60d6ea465cf Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Sat, 17 Jun 2023 00:52:25 +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 --- .../google-cloud-billing/v1/.coveragerc | 13 - .../google-cloud-billing/v1/.flake8 | 33 - .../google-cloud-billing/v1/MANIFEST.in | 2 - .../google-cloud-billing/v1/README.rst | 49 - .../v1/docs/billing_v1/cloud_billing.rst | 10 - .../v1/docs/billing_v1/cloud_catalog.rst | 10 - .../v1/docs/billing_v1/services.rst | 7 - .../v1/docs/billing_v1/types.rst | 6 - .../google-cloud-billing/v1/docs/conf.py | 376 - .../google-cloud-billing/v1/docs/index.rst | 7 - .../v1/google/cloud/billing/__init__.py | 75 - .../v1/google/cloud/billing/gapic_version.py | 16 - .../v1/google/cloud/billing/py.typed | 2 - .../v1/google/cloud/billing_v1/__init__.py | 76 - .../cloud/billing_v1/gapic_metadata.json | 227 - .../google/cloud/billing_v1/gapic_version.py | 16 - .../v1/google/cloud/billing_v1/py.typed | 2 - .../cloud/billing_v1/services/__init__.py | 15 - .../services/cloud_billing/__init__.py | 22 - .../services/cloud_billing/async_client.py | 1508 ---- .../services/cloud_billing/client.py | 1649 ----- .../services/cloud_billing/pagers.py | 260 - .../cloud_billing/transports/__init__.py | 38 - .../services/cloud_billing/transports/base.py | 341 - .../services/cloud_billing/transports/grpc.py | 578 -- .../cloud_billing/transports/grpc_asyncio.py | 577 -- .../services/cloud_billing/transports/rest.py | 1490 ---- .../services/cloud_catalog/__init__.py | 22 - .../services/cloud_catalog/async_client.py | 399 -- .../services/cloud_catalog/client.py | 613 -- .../services/cloud_catalog/pagers.py | 260 - .../cloud_catalog/transports/__init__.py | 38 - .../services/cloud_catalog/transports/base.py | 164 - .../services/cloud_catalog/transports/grpc.py | 293 - .../cloud_catalog/transports/grpc_asyncio.py | 292 - .../services/cloud_catalog/transports/rest.py | 392 -- .../google/cloud/billing_v1/types/__init__.py | 66 - .../cloud/billing_v1/types/cloud_billing.py | 377 - .../cloud/billing_v1/types/cloud_catalog.py | 602 -- .../google-cloud-billing/v1/mypy.ini | 3 - .../google-cloud-billing/v1/noxfile.py | 184 - .../v1/scripts/fixup_billing_v1_keywords.py | 187 - .../google-cloud-billing/v1/setup.py | 91 - .../v1/testing/constraints-3.10.txt | 7 - .../v1/testing/constraints-3.11.txt | 7 - .../v1/testing/constraints-3.12.txt | 7 - .../v1/testing/constraints-3.7.txt | 10 - .../v1/testing/constraints-3.8.txt | 7 - .../v1/testing/constraints-3.9.txt | 7 - .../google-cloud-billing/v1/tests/__init__.py | 16 - .../v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../tests/unit/gapic/billing_v1/__init__.py | 16 - .../gapic/billing_v1/test_cloud_billing.py | 6262 ----------------- .../gapic/billing_v1/test_cloud_catalog.py | 2385 ------- .../google/cloud/billing/gapic_version.py | 2 +- .../google/cloud/billing_v1/gapic_version.py | 2 +- .../services/cloud_billing/async_client.py | 6 + .../services/cloud_billing/client.py | 15 + .../cloud/billing_v1/types/cloud_billing.py | 28 +- ...ud_billing_create_billing_account_async.py | 0 ...oud_billing_create_billing_account_sync.py | 0 ...cloud_billing_get_billing_account_async.py | 0 ..._cloud_billing_get_billing_account_sync.py | 0 ...ated_cloud_billing_get_iam_policy_async.py | 0 ...rated_cloud_billing_get_iam_policy_sync.py | 0 ..._billing_get_project_billing_info_async.py | 0 ...d_billing_get_project_billing_info_sync.py | 0 ...oud_billing_list_billing_accounts_async.py | 0 ...loud_billing_list_billing_accounts_sync.py | 0 ...billing_list_project_billing_info_async.py | 0 ..._billing_list_project_billing_info_sync.py | 0 ...ated_cloud_billing_set_iam_policy_async.py | 0 ...rated_cloud_billing_set_iam_policy_sync.py | 0 ...loud_billing_test_iam_permissions_async.py | 0 ...cloud_billing_test_iam_permissions_sync.py | 0 ...ud_billing_update_billing_account_async.py | 0 ...oud_billing_update_billing_account_sync.py | 0 ...lling_update_project_billing_info_async.py | 0 ...illing_update_project_billing_info_sync.py | 0 ...rated_cloud_catalog_list_services_async.py | 0 ...erated_cloud_catalog_list_services_sync.py | 0 ...generated_cloud_catalog_list_skus_async.py | 0 ..._generated_cloud_catalog_list_skus_sync.py | 0 ...ppet_metadata_google.cloud.billing.v1.json | 0 .../gapic/billing_v1/test_cloud_billing.py | 44 +- 86 files changed, 70 insertions(+), 20171 deletions(-) delete mode 100644 owl-bot-staging/google-cloud-billing/v1/.coveragerc delete mode 100644 owl-bot-staging/google-cloud-billing/v1/.flake8 delete mode 100644 owl-bot-staging/google-cloud-billing/v1/MANIFEST.in delete mode 100644 owl-bot-staging/google-cloud-billing/v1/README.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/conf.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/docs/index.rst delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/mypy.ini delete mode 100644 owl-bot-staging/google-cloud-billing/v1/noxfile.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/setup.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py delete mode 100644 owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py (100%) rename {owl-bot-staging/google-cloud-billing/v1 => packages/google-cloud-billing}/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json (100%) diff --git a/owl-bot-staging/google-cloud-billing/v1/.coveragerc b/owl-bot-staging/google-cloud-billing/v1/.coveragerc deleted file mode 100644 index 9d5c973460e2..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/billing/__init__.py - google/cloud/billing/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/google-cloud-billing/v1/.flake8 b/owl-bot-staging/google-cloud-billing/v1/.flake8 deleted file mode 100644 index 29227d4cf419..000000000000 --- a/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/MANIFEST.in b/owl-bot-staging/google-cloud-billing/v1/MANIFEST.in deleted file mode 100644 index c96c710b2dd8..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/billing *.py -recursive-include google/cloud/billing_v1 *.py diff --git a/owl-bot-staging/google-cloud-billing/v1/README.rst b/owl-bot-staging/google-cloud-billing/v1/README.rst deleted file mode 100644 index d63a58dc0f74..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Billing 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 Billing 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/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst deleted file mode 100644 index 08631bdaf3cf..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_billing.rst +++ /dev/null @@ -1,10 +0,0 @@ -CloudBilling ------------------------------- - -.. automodule:: google.cloud.billing_v1.services.cloud_billing - :members: - :inherited-members: - -.. automodule:: google.cloud.billing_v1.services.cloud_billing.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst deleted file mode 100644 index 6795e651418d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/cloud_catalog.rst +++ /dev/null @@ -1,10 +0,0 @@ -CloudCatalog ------------------------------- - -.. automodule:: google.cloud.billing_v1.services.cloud_catalog - :members: - :inherited-members: - -.. automodule:: google.cloud.billing_v1.services.cloud_catalog.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst deleted file mode 100644 index 934883679ee3..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/services.rst +++ /dev/null @@ -1,7 +0,0 @@ -Services for Google Cloud Billing v1 API -======================================== -.. toctree:: - :maxdepth: 2 - - cloud_billing - cloud_catalog diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst b/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst deleted file mode 100644 index 75c1f9f0fdc2..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/docs/billing_v1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Billing v1 API -===================================== - -.. automodule:: google.cloud.billing_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/google-cloud-billing/v1/docs/conf.py b/owl-bot-staging/google-cloud-billing/v1/docs/conf.py deleted file mode 100644 index c7a7757a2426..000000000000 --- a/owl-bot-staging/google-cloud-billing/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-billing 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-billing" -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-billing-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-billing.tex", - u"google-cloud-billing 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-billing", - u"Google Cloud Billing 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-billing", - u"google-cloud-billing Documentation", - author, - "google-cloud-billing", - "GAPIC library for Google Cloud Billing 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/google-cloud-billing/v1/docs/index.rst b/owl-bot-staging/google-cloud-billing/v1/docs/index.rst deleted file mode 100644 index ba505d00d3b6..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - billing_v1/services - billing_v1/types diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py deleted file mode 100644 index 7e8c105aacf6..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/__init__.py +++ /dev/null @@ -1,75 +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.billing import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.billing_v1.services.cloud_billing.client import CloudBillingClient -from google.cloud.billing_v1.services.cloud_billing.async_client import CloudBillingAsyncClient -from google.cloud.billing_v1.services.cloud_catalog.client import CloudCatalogClient -from google.cloud.billing_v1.services.cloud_catalog.async_client import CloudCatalogAsyncClient - -from google.cloud.billing_v1.types.cloud_billing import BillingAccount -from google.cloud.billing_v1.types.cloud_billing import CreateBillingAccountRequest -from google.cloud.billing_v1.types.cloud_billing import GetBillingAccountRequest -from google.cloud.billing_v1.types.cloud_billing import GetProjectBillingInfoRequest -from google.cloud.billing_v1.types.cloud_billing import ListBillingAccountsRequest -from google.cloud.billing_v1.types.cloud_billing import ListBillingAccountsResponse -from google.cloud.billing_v1.types.cloud_billing import ListProjectBillingInfoRequest -from google.cloud.billing_v1.types.cloud_billing import ListProjectBillingInfoResponse -from google.cloud.billing_v1.types.cloud_billing import ProjectBillingInfo -from google.cloud.billing_v1.types.cloud_billing import UpdateBillingAccountRequest -from google.cloud.billing_v1.types.cloud_billing import UpdateProjectBillingInfoRequest -from google.cloud.billing_v1.types.cloud_catalog import AggregationInfo -from google.cloud.billing_v1.types.cloud_catalog import Category -from google.cloud.billing_v1.types.cloud_catalog import GeoTaxonomy -from google.cloud.billing_v1.types.cloud_catalog import ListServicesRequest -from google.cloud.billing_v1.types.cloud_catalog import ListServicesResponse -from google.cloud.billing_v1.types.cloud_catalog import ListSkusRequest -from google.cloud.billing_v1.types.cloud_catalog import ListSkusResponse -from google.cloud.billing_v1.types.cloud_catalog import PricingExpression -from google.cloud.billing_v1.types.cloud_catalog import PricingInfo -from google.cloud.billing_v1.types.cloud_catalog import Service -from google.cloud.billing_v1.types.cloud_catalog import Sku - -__all__ = ('CloudBillingClient', - 'CloudBillingAsyncClient', - 'CloudCatalogClient', - 'CloudCatalogAsyncClient', - 'BillingAccount', - 'CreateBillingAccountRequest', - 'GetBillingAccountRequest', - 'GetProjectBillingInfoRequest', - 'ListBillingAccountsRequest', - 'ListBillingAccountsResponse', - 'ListProjectBillingInfoRequest', - 'ListProjectBillingInfoResponse', - 'ProjectBillingInfo', - 'UpdateBillingAccountRequest', - 'UpdateProjectBillingInfoRequest', - 'AggregationInfo', - 'Category', - 'GeoTaxonomy', - 'ListServicesRequest', - 'ListServicesResponse', - 'ListSkusRequest', - 'ListSkusResponse', - 'PricingExpression', - 'PricingInfo', - 'Service', - 'Sku', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/gapic_version.py deleted file mode 100644 index 405b1cebcf15..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/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/google-cloud-billing/v1/google/cloud/billing/py.typed b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed deleted file mode 100644 index 5e186150e95f..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-billing package uses inline types. diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py deleted file mode 100644 index 8253e44be786..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/__init__.py +++ /dev/null @@ -1,76 +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.billing_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.cloud_billing import CloudBillingClient -from .services.cloud_billing import CloudBillingAsyncClient -from .services.cloud_catalog import CloudCatalogClient -from .services.cloud_catalog import CloudCatalogAsyncClient - -from .types.cloud_billing import BillingAccount -from .types.cloud_billing import CreateBillingAccountRequest -from .types.cloud_billing import GetBillingAccountRequest -from .types.cloud_billing import GetProjectBillingInfoRequest -from .types.cloud_billing import ListBillingAccountsRequest -from .types.cloud_billing import ListBillingAccountsResponse -from .types.cloud_billing import ListProjectBillingInfoRequest -from .types.cloud_billing import ListProjectBillingInfoResponse -from .types.cloud_billing import ProjectBillingInfo -from .types.cloud_billing import UpdateBillingAccountRequest -from .types.cloud_billing import UpdateProjectBillingInfoRequest -from .types.cloud_catalog import AggregationInfo -from .types.cloud_catalog import Category -from .types.cloud_catalog import GeoTaxonomy -from .types.cloud_catalog import ListServicesRequest -from .types.cloud_catalog import ListServicesResponse -from .types.cloud_catalog import ListSkusRequest -from .types.cloud_catalog import ListSkusResponse -from .types.cloud_catalog import PricingExpression -from .types.cloud_catalog import PricingInfo -from .types.cloud_catalog import Service -from .types.cloud_catalog import Sku - -__all__ = ( - 'CloudBillingAsyncClient', - 'CloudCatalogAsyncClient', -'AggregationInfo', -'BillingAccount', -'Category', -'CloudBillingClient', -'CloudCatalogClient', -'CreateBillingAccountRequest', -'GeoTaxonomy', -'GetBillingAccountRequest', -'GetProjectBillingInfoRequest', -'ListBillingAccountsRequest', -'ListBillingAccountsResponse', -'ListProjectBillingInfoRequest', -'ListProjectBillingInfoResponse', -'ListServicesRequest', -'ListServicesResponse', -'ListSkusRequest', -'ListSkusResponse', -'PricingExpression', -'PricingInfo', -'ProjectBillingInfo', -'Service', -'Sku', -'UpdateBillingAccountRequest', -'UpdateProjectBillingInfoRequest', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json deleted file mode 100644 index d7464c62897f..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_metadata.json +++ /dev/null @@ -1,227 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.billing_v1", - "protoPackage": "google.cloud.billing.v1", - "schema": "1.0", - "services": { - "CloudBilling": { - "clients": { - "grpc": { - "libraryClient": "CloudBillingClient", - "rpcs": { - "CreateBillingAccount": { - "methods": [ - "create_billing_account" - ] - }, - "GetBillingAccount": { - "methods": [ - "get_billing_account" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetProjectBillingInfo": { - "methods": [ - "get_project_billing_info" - ] - }, - "ListBillingAccounts": { - "methods": [ - "list_billing_accounts" - ] - }, - "ListProjectBillingInfo": { - "methods": [ - "list_project_billing_info" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateBillingAccount": { - "methods": [ - "update_billing_account" - ] - }, - "UpdateProjectBillingInfo": { - "methods": [ - "update_project_billing_info" - ] - } - } - }, - "grpc-async": { - "libraryClient": "CloudBillingAsyncClient", - "rpcs": { - "CreateBillingAccount": { - "methods": [ - "create_billing_account" - ] - }, - "GetBillingAccount": { - "methods": [ - "get_billing_account" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetProjectBillingInfo": { - "methods": [ - "get_project_billing_info" - ] - }, - "ListBillingAccounts": { - "methods": [ - "list_billing_accounts" - ] - }, - "ListProjectBillingInfo": { - "methods": [ - "list_project_billing_info" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateBillingAccount": { - "methods": [ - "update_billing_account" - ] - }, - "UpdateProjectBillingInfo": { - "methods": [ - "update_project_billing_info" - ] - } - } - }, - "rest": { - "libraryClient": "CloudBillingClient", - "rpcs": { - "CreateBillingAccount": { - "methods": [ - "create_billing_account" - ] - }, - "GetBillingAccount": { - "methods": [ - "get_billing_account" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetProjectBillingInfo": { - "methods": [ - "get_project_billing_info" - ] - }, - "ListBillingAccounts": { - "methods": [ - "list_billing_accounts" - ] - }, - "ListProjectBillingInfo": { - "methods": [ - "list_project_billing_info" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateBillingAccount": { - "methods": [ - "update_billing_account" - ] - }, - "UpdateProjectBillingInfo": { - "methods": [ - "update_project_billing_info" - ] - } - } - } - } - }, - "CloudCatalog": { - "clients": { - "grpc": { - "libraryClient": "CloudCatalogClient", - "rpcs": { - "ListServices": { - "methods": [ - "list_services" - ] - }, - "ListSkus": { - "methods": [ - "list_skus" - ] - } - } - }, - "grpc-async": { - "libraryClient": "CloudCatalogAsyncClient", - "rpcs": { - "ListServices": { - "methods": [ - "list_services" - ] - }, - "ListSkus": { - "methods": [ - "list_skus" - ] - } - } - }, - "rest": { - "libraryClient": "CloudCatalogClient", - "rpcs": { - "ListServices": { - "methods": [ - "list_services" - ] - }, - "ListSkus": { - "methods": [ - "list_skus" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/gapic_version.py deleted file mode 100644 index 405b1cebcf15..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_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/google-cloud-billing/v1/google/cloud/billing_v1/py.typed b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed deleted file mode 100644 index 5e186150e95f..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-billing package uses inline types. diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/__init__.py deleted file mode 100644 index e8e1c3845db5..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_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/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py deleted file mode 100644 index 23604d7beb4a..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/__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 CloudBillingClient -from .async_client import CloudBillingAsyncClient - -__all__ = ( - 'CloudBillingClient', - 'CloudBillingAsyncClient', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py deleted file mode 100644 index 5d40efc79657..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py +++ /dev/null @@ -1,1508 +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.billing_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.cloud.billing_v1.services.cloud_billing import pagers -from google.cloud.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport -from .client import CloudBillingClient - - -class CloudBillingAsyncClient: - """Retrieves the Google Cloud Console billing accounts and - associates them with projects. - """ - - _client: CloudBillingClient - - DEFAULT_ENDPOINT = CloudBillingClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = CloudBillingClient.DEFAULT_MTLS_ENDPOINT - - project_billing_info_path = staticmethod(CloudBillingClient.project_billing_info_path) - parse_project_billing_info_path = staticmethod(CloudBillingClient.parse_project_billing_info_path) - common_billing_account_path = staticmethod(CloudBillingClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(CloudBillingClient.parse_common_billing_account_path) - common_folder_path = staticmethod(CloudBillingClient.common_folder_path) - parse_common_folder_path = staticmethod(CloudBillingClient.parse_common_folder_path) - common_organization_path = staticmethod(CloudBillingClient.common_organization_path) - parse_common_organization_path = staticmethod(CloudBillingClient.parse_common_organization_path) - common_project_path = staticmethod(CloudBillingClient.common_project_path) - parse_common_project_path = staticmethod(CloudBillingClient.parse_common_project_path) - common_location_path = staticmethod(CloudBillingClient.common_location_path) - parse_common_location_path = staticmethod(CloudBillingClient.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: - CloudBillingAsyncClient: The constructed client. - """ - return CloudBillingClient.from_service_account_info.__func__(CloudBillingAsyncClient, 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: - CloudBillingAsyncClient: The constructed client. - """ - return CloudBillingClient.from_service_account_file.__func__(CloudBillingAsyncClient, 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 CloudBillingClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> CloudBillingTransport: - """Returns the transport used by the client instance. - - Returns: - CloudBillingTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(CloudBillingClient).get_transport_class, type(CloudBillingClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, CloudBillingTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the cloud billing 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, ~.CloudBillingTransport]): 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 = CloudBillingClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def get_billing_account(self, - request: Optional[Union[cloud_billing.GetBillingAccountRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""Gets information about a billing account. The current - authenticated user must be a `viewer of the billing - account `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_get_billing_account(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.GetBillingAccountRequest( - name="name_value", - ) - - # Make the request - response = await client.get_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.GetBillingAccountRequest, dict]]): - The request object. Request message for ``GetBillingAccount``. - name (:class:`str`): - Required. The resource name of the billing account to - retrieve. For example, - ``billingAccounts/012345-567890-ABCDEF``. - - 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.GetBillingAccountRequest(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_billing_account, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_billing_accounts(self, - request: Optional[Union[cloud_billing.ListBillingAccountsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListBillingAccountsAsyncPager: - r"""Lists the billing accounts that the current authenticated user - has permission to - `view `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_list_billing_accounts(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.ListBillingAccountsRequest( - ) - - # Make the request - page_result = client.list_billing_accounts(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.ListBillingAccountsRequest, dict]]): - The request object. Request message for ``ListBillingAccounts``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager: - Response message for ListBillingAccounts. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - request = cloud_billing.ListBillingAccountsRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_billing_accounts, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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.ListBillingAccountsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_billing_account(self, - request: Optional[Union[cloud_billing.UpdateBillingAccountRequest, dict]] = None, - *, - name: Optional[str] = None, - account: Optional[cloud_billing.BillingAccount] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""Updates a billing account's fields. Currently the only field - that can be edited is ``display_name``. The current - authenticated user must have the ``billing.accounts.update`` IAM - permission, which is typically given to the - `administrator `__ - of the billing account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_update_billing_account(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.UpdateBillingAccountRequest( - name="name_value", - ) - - # Make the request - response = await client.update_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.UpdateBillingAccountRequest, dict]]): - The request object. Request message for ``UpdateBillingAccount``. - name (:class:`str`): - Required. The name of the billing - account resource to be updated. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - account (:class:`google.cloud.billing_v1.types.BillingAccount`): - Required. The billing account - resource to replace the resource on the - server. - - This corresponds to the ``account`` 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a 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, account]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.UpdateBillingAccountRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if account is not None: - request.account = account - - # 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_billing_account, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_billing_account(self, - request: Optional[Union[cloud_billing.CreateBillingAccountRequest, dict]] = None, - *, - billing_account: Optional[cloud_billing.BillingAccount] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""This method creates `billing - subaccounts `__. - - Google Cloud resellers should use the Channel Services APIs, - `accounts.customers.create `__ - and - `accounts.customers.entitlements.create `__. - - When creating a subaccount, the current authenticated user must - have the ``billing.accounts.update`` IAM permission on the - parent account, which is typically given to billing account - `administrators `__. - This method will return an error if the parent account has not - been provisioned as a reseller account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_create_billing_account(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.CreateBillingAccountRequest( - ) - - # Make the request - response = await client.create_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.CreateBillingAccountRequest, dict]]): - The request object. Request message for ``CreateBillingAccount``. - billing_account (:class:`google.cloud.billing_v1.types.BillingAccount`): - Required. The billing account - resource to create. Currently - CreateBillingAccount only supports - subaccount creation, so any created - billing accounts must be under a - provided parent billing account. - - This corresponds to the ``billing_account`` 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a 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([billing_account]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.CreateBillingAccountRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if billing_account is not None: - request.billing_account = billing_account - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_billing_account, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_project_billing_info(self, - request: Optional[Union[cloud_billing.ListProjectBillingInfoRequest, 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]] = (), - ) -> pagers.ListProjectBillingInfoAsyncPager: - r"""Lists the projects associated with a billing account. The - current authenticated user must have the - ``billing.resourceAssociations.list`` IAM permission, which is - often given to billing account - `viewers `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_list_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.ListProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - page_result = client.list_project_billing_info(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.ListProjectBillingInfoRequest, dict]]): - The request object. Request message for ``ListProjectBillingInfo``. - name (:class:`str`): - Required. The resource name of the billing account - associated with the projects that you want to list. For - example, ``billingAccounts/012345-567890-ABCDEF``. - - 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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager: - Request message for ListProjectBillingInfoResponse. - - 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([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.ListProjectBillingInfoRequest(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.list_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListProjectBillingInfoAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_project_billing_info(self, - request: Optional[Union[cloud_billing.GetProjectBillingInfoRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.ProjectBillingInfo: - r"""Gets the billing information for a project. The current - authenticated user must have the - ``resourcemanager.projects.get`` permission for the project, - which can be granted by assigning the `Project - Viewer `__ - role. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_get_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.GetProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - response = await client.get_project_billing_info(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.GetProjectBillingInfoRequest, dict]]): - The request object. Request message for ``GetProjectBillingInfo``. - name (:class:`str`): - Required. The resource name of the project for which - billing information is retrieved. For example, - ``projects/tokyo-rain-123``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.billing_v1.types.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.GetProjectBillingInfoRequest(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_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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_project_billing_info(self, - request: Optional[Union[cloud_billing.UpdateProjectBillingInfoRequest, dict]] = None, - *, - name: Optional[str] = None, - project_billing_info: Optional[cloud_billing.ProjectBillingInfo] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.ProjectBillingInfo: - r"""Sets or updates the billing account associated with a project. - You specify the new billing account by setting the - ``billing_account_name`` in the ``ProjectBillingInfo`` resource - to the resource name of a billing account. Associating a project - with an open billing account enables billing on the project and - allows charges for resource usage. If the project already had a - billing account, this method changes the billing account used - for resource usage charges. - - *Note:* Incurred charges that have not yet been reported in the - transaction history of the Google Cloud Console might be billed - to the new billing account, even if the charge occurred before - the new billing account was assigned to the project. - - The current authenticated user must have ownership privileges - for both the - `project `__ - and the `billing - account `__. - - You can disable billing on the project by setting the - ``billing_account_name`` field to empty. This action - disassociates the current billing account from the project. Any - billable activity of your in-use services will stop, and your - application could stop functioning as expected. Any unbilled - charges to date will be billed to the previously associated - account. The current authenticated user must be either an owner - of the project or an owner of the billing account for the - project. - - Note that associating a project with a *closed* billing account - will have much the same effect as disabling billing on the - project: any paid resources used by the project will be shut - down. Thus, unless you wish to disable billing, you should - always call this method with the name of an *open* billing - account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_update_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = billing_v1.UpdateProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - response = await client.update_project_billing_info(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest, dict]]): - The request object. Request message for ``UpdateProjectBillingInfo``. - name (:class:`str`): - Required. The resource name of the project associated - with the billing information that you want to update. - For example, ``projects/tokyo-rain-123``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - project_billing_info (:class:`google.cloud.billing_v1.types.ProjectBillingInfo`): - The new billing information for the project. Read-only - fields are ignored; thus, you can leave empty all fields - except ``billing_account_name``. - - This corresponds to the ``project_billing_info`` 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.billing_v1.types.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - # Create or coerce a 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, project_billing_info]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_billing.UpdateProjectBillingInfoRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if project_billing_info is not None: - request.project_billing_info = project_billing_info - - # 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_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_iam_policy(self, - request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a billing account. The caller - must have the ``billing.accounts.getIamPolicy`` permission on - the account, which is often given to billing account - `viewers `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_get_iam_policy(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.GetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = await client.get_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]): - The request object. Request message for ``GetIamPolicy`` method. - resource (:class:`str`): - REQUIRED: The resource for which the - policy is being requested. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": [ "user:eve@example.com" ], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ], "etag": "BwWWja0YfJA=", "version": 3 - - } - - **YAML example:** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: - BwWWja0YfJA= version: 3 - - For a description of IAM and its features, see the - [IAM - documentation](\ https://cloud.google.com/iam/docs/). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([resource]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.GetIamPolicyRequest(**request) - elif not request: - request = iam_policy_pb2.GetIamPolicyRequest(resource=resource, ) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_iam_policy, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def set_iam_policy(self, - request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Sets the access control policy for a billing account. Replaces - any existing policy. The caller must have the - ``billing.accounts.setIamPolicy`` permission on the account, - which is often given to billing account - `administrators `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_set_iam_policy(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.SetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = await client.set_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]): - The request object. Request message for ``SetIamPolicy`` method. - resource (:class:`str`): - REQUIRED: The resource for which the - policy is being specified. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": [ "user:eve@example.com" ], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ], "etag": "BwWWja0YfJA=", "version": 3 - - } - - **YAML example:** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: - BwWWja0YfJA= version: 3 - - For a description of IAM and its features, see the - [IAM - documentation](\ https://cloud.google.com/iam/docs/). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([resource]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.SetIamPolicyRequest(**request) - elif not request: - request = iam_policy_pb2.SetIamPolicyRequest(resource=resource, ) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.set_iam_policy, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def test_iam_permissions(self, - request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, - *, - resource: Optional[str] = None, - permissions: Optional[MutableSequence[str]] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Tests the access control policy for a billing - account. This method takes the resource and a set of - permissions as input and returns the subset of the input - permissions that the caller is allowed for that - 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 billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_test_iam_permissions(): - # Create a client - client = billing_v1.CloudBillingAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.TestIamPermissionsRequest( - resource="resource_value", - permissions=['permissions_value1', 'permissions_value2'], - ) - - # Make the request - response = await client.test_iam_permissions(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]): - The request object. Request message for ``TestIamPermissions`` method. - resource (:class:`str`): - REQUIRED: The resource for which the - policy detail is being requested. See - the operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - permissions (:class:`MutableSequence[str]`): - The set of permissions to check for the ``resource``. - Permissions with wildcards (such as '*' or 'storage.*') - are not allowed. For more information see `IAM - Overview `__. - - This corresponds to the ``permissions`` 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.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions 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([resource, permissions]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.TestIamPermissionsRequest(**request) - elif not request: - request = iam_policy_pb2.TestIamPermissionsRequest(resource=resource, permissions=permissions, ) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.test_iam_permissions, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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(( - ("resource", request.resource), - )), - ) - - # 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__ = ( - "CloudBillingAsyncClient", -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py deleted file mode 100644 index b3b667df034d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/client.py +++ /dev/null @@ -1,1649 +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.billing_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.cloud.billing_v1.services.cloud_billing import pagers -from google.cloud.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import CloudBillingGrpcTransport -from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport -from .transports.rest import CloudBillingRestTransport - - -class CloudBillingClientMeta(type): - """Metaclass for the CloudBilling 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[CloudBillingTransport]] - _transport_registry["grpc"] = CloudBillingGrpcTransport - _transport_registry["grpc_asyncio"] = CloudBillingGrpcAsyncIOTransport - _transport_registry["rest"] = CloudBillingRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[CloudBillingTransport]: - """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 CloudBillingClient(metaclass=CloudBillingClientMeta): - """Retrieves the Google Cloud Console billing accounts and - associates them with projects. - """ - - @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 = "cloudbilling.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: - CloudBillingClient: 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: - CloudBillingClient: 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) -> CloudBillingTransport: - """Returns the transport used by the client instance. - - Returns: - CloudBillingTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def project_billing_info_path(project: str,) -> str: - """Returns a fully-qualified project_billing_info string.""" - return "projects/{project}/billingInfo".format(project=project, ) - - @staticmethod - def parse_project_billing_info_path(path: str) -> Dict[str,str]: - """Parses a project_billing_info path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/billingInfo$", 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, CloudBillingTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the cloud billing 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, CloudBillingTransport]): 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, CloudBillingTransport): - # transport is a CloudBillingTransport 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 get_billing_account(self, - request: Optional[Union[cloud_billing.GetBillingAccountRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""Gets information about a billing account. The current - authenticated user must be a `viewer of the billing - account `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_get_billing_account(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.GetBillingAccountRequest( - name="name_value", - ) - - # Make the request - response = client.get_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.GetBillingAccountRequest, dict]): - The request object. Request message for ``GetBillingAccount``. - name (str): - Required. The resource name of the billing account to - retrieve. For example, - ``billingAccounts/012345-567890-ABCDEF``. - - 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.GetBillingAccountRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.GetBillingAccountRequest): - request = cloud_billing.GetBillingAccountRequest(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_billing_account] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_billing_accounts(self, - request: Optional[Union[cloud_billing.ListBillingAccountsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListBillingAccountsPager: - r"""Lists the billing accounts that the current authenticated user - has permission to - `view `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_list_billing_accounts(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.ListBillingAccountsRequest( - ) - - # Make the request - page_result = client.list_billing_accounts(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.ListBillingAccountsRequest, dict]): - The request object. Request message for ``ListBillingAccounts``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager: - Response message for ListBillingAccounts. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.ListBillingAccountsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.ListBillingAccountsRequest): - request = cloud_billing.ListBillingAccountsRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_billing_accounts] - - # 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.ListBillingAccountsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_billing_account(self, - request: Optional[Union[cloud_billing.UpdateBillingAccountRequest, dict]] = None, - *, - name: Optional[str] = None, - account: Optional[cloud_billing.BillingAccount] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""Updates a billing account's fields. Currently the only field - that can be edited is ``display_name``. The current - authenticated user must have the ``billing.accounts.update`` IAM - permission, which is typically given to the - `administrator `__ - of the billing account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_update_billing_account(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.UpdateBillingAccountRequest( - name="name_value", - ) - - # Make the request - response = client.update_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.UpdateBillingAccountRequest, dict]): - The request object. Request message for ``UpdateBillingAccount``. - name (str): - Required. The name of the billing - account resource to be updated. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - account (google.cloud.billing_v1.types.BillingAccount): - Required. The billing account - resource to replace the resource on the - server. - - This corresponds to the ``account`` 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a 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, account]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.UpdateBillingAccountRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.UpdateBillingAccountRequest): - request = cloud_billing.UpdateBillingAccountRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if account is not None: - request.account = account - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_billing_account] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_billing_account(self, - request: Optional[Union[cloud_billing.CreateBillingAccountRequest, dict]] = None, - *, - billing_account: Optional[cloud_billing.BillingAccount] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.BillingAccount: - r"""This method creates `billing - subaccounts `__. - - Google Cloud resellers should use the Channel Services APIs, - `accounts.customers.create `__ - and - `accounts.customers.entitlements.create `__. - - When creating a subaccount, the current authenticated user must - have the ``billing.accounts.update`` IAM permission on the - parent account, which is typically given to billing account - `administrators `__. - This method will return an error if the parent account has not - been provisioned as a reseller account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_create_billing_account(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.CreateBillingAccountRequest( - ) - - # Make the request - response = client.create_billing_account(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.CreateBillingAccountRequest, dict]): - The request object. Request message for ``CreateBillingAccount``. - billing_account (google.cloud.billing_v1.types.BillingAccount): - Required. The billing account - resource to create. Currently - CreateBillingAccount only supports - subaccount creation, so any created - billing accounts must be under a - provided parent billing account. - - This corresponds to the ``billing_account`` 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.billing_v1.types.BillingAccount: - A billing account in the - [Google Cloud - Console](\ https://console.cloud.google.com/). You - can assign a billing account to one or more projects. - - """ - # Create or coerce a 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([billing_account]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.CreateBillingAccountRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.CreateBillingAccountRequest): - request = cloud_billing.CreateBillingAccountRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if billing_account is not None: - request.billing_account = billing_account - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_billing_account] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_project_billing_info(self, - request: Optional[Union[cloud_billing.ListProjectBillingInfoRequest, 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]] = (), - ) -> pagers.ListProjectBillingInfoPager: - r"""Lists the projects associated with a billing account. The - current authenticated user must have the - ``billing.resourceAssociations.list`` IAM permission, which is - often given to billing account - `viewers `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_list_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.ListProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - page_result = client.list_project_billing_info(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.ListProjectBillingInfoRequest, dict]): - The request object. Request message for ``ListProjectBillingInfo``. - name (str): - Required. The resource name of the billing account - associated with the projects that you want to list. For - example, ``billingAccounts/012345-567890-ABCDEF``. - - 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.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager: - Request message for ListProjectBillingInfoResponse. - - 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([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.ListProjectBillingInfoRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.ListProjectBillingInfoRequest): - request = cloud_billing.ListProjectBillingInfoRequest(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.list_project_billing_info] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListProjectBillingInfoPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_project_billing_info(self, - request: Optional[Union[cloud_billing.GetProjectBillingInfoRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.ProjectBillingInfo: - r"""Gets the billing information for a project. The current - authenticated user must have the - ``resourcemanager.projects.get`` permission for the project, - which can be granted by assigning the `Project - Viewer `__ - role. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_get_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.GetProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - response = client.get_project_billing_info(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.GetProjectBillingInfoRequest, dict]): - The request object. Request message for ``GetProjectBillingInfo``. - name (str): - Required. The resource name of the project for which - billing information is retrieved. For example, - ``projects/tokyo-rain-123``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.billing_v1.types.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.GetProjectBillingInfoRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.GetProjectBillingInfoRequest): - request = cloud_billing.GetProjectBillingInfoRequest(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_project_billing_info] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_project_billing_info(self, - request: Optional[Union[cloud_billing.UpdateProjectBillingInfoRequest, dict]] = None, - *, - name: Optional[str] = None, - project_billing_info: Optional[cloud_billing.ProjectBillingInfo] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_billing.ProjectBillingInfo: - r"""Sets or updates the billing account associated with a project. - You specify the new billing account by setting the - ``billing_account_name`` in the ``ProjectBillingInfo`` resource - to the resource name of a billing account. Associating a project - with an open billing account enables billing on the project and - allows charges for resource usage. If the project already had a - billing account, this method changes the billing account used - for resource usage charges. - - *Note:* Incurred charges that have not yet been reported in the - transaction history of the Google Cloud Console might be billed - to the new billing account, even if the charge occurred before - the new billing account was assigned to the project. - - The current authenticated user must have ownership privileges - for both the - `project `__ - and the `billing - account `__. - - You can disable billing on the project by setting the - ``billing_account_name`` field to empty. This action - disassociates the current billing account from the project. Any - billable activity of your in-use services will stop, and your - application could stop functioning as expected. Any unbilled - charges to date will be billed to the previously associated - account. The current authenticated user must be either an owner - of the project or an owner of the billing account for the - project. - - Note that associating a project with a *closed* billing account - will have much the same effect as disabling billing on the - project: any paid resources used by the project will be shut - down. Thus, unless you wish to disable billing, you should - always call this method with the name of an *open* billing - account. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_update_project_billing_info(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = billing_v1.UpdateProjectBillingInfoRequest( - name="name_value", - ) - - # Make the request - response = client.update_project_billing_info(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest, dict]): - The request object. Request message for ``UpdateProjectBillingInfo``. - name (str): - Required. The resource name of the project associated - with the billing information that you want to update. - For example, ``projects/tokyo-rain-123``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - project_billing_info (google.cloud.billing_v1.types.ProjectBillingInfo): - The new billing information for the project. Read-only - fields are ignored; thus, you can leave empty all fields - except ``billing_account_name``. - - This corresponds to the ``project_billing_info`` 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.billing_v1.types.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - # Create or coerce a 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, project_billing_info]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_billing.UpdateProjectBillingInfoRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_billing.UpdateProjectBillingInfoRequest): - request = cloud_billing.UpdateProjectBillingInfoRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if project_billing_info is not None: - request.project_billing_info = project_billing_info - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_project_billing_info] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_iam_policy(self, - request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a billing account. The caller - must have the ``billing.accounts.getIamPolicy`` permission on - the account, which is often given to billing account - `viewers `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_get_iam_policy(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = iam_policy_pb2.GetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = client.get_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): - The request object. Request message for ``GetIamPolicy`` method. - resource (str): - REQUIRED: The resource for which the - policy is being requested. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": [ "user:eve@example.com" ], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ], "etag": "BwWWja0YfJA=", "version": 3 - - } - - **YAML example:** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: - BwWWja0YfJA= version: 3 - - For a description of IAM and its features, see the - [IAM - documentation](\ https://cloud.google.com/iam/docs/). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([resource]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.GetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.GetIamPolicyRequest() - if resource is not None: - request.resource = resource - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def set_iam_policy(self, - request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> policy_pb2.Policy: - r"""Sets the access control policy for a billing account. Replaces - any existing policy. The caller must have the - ``billing.accounts.setIamPolicy`` permission on the account, - which is often given to billing account - `administrators `__. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_set_iam_policy(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = iam_policy_pb2.SetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = client.set_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): - The request object. Request message for ``SetIamPolicy`` method. - resource (str): - REQUIRED: The resource for which the - policy is being specified. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - { - "bindings": [ - { - "role": - "roles/resourcemanager.organizationAdmin", - "members": [ "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - - }, { "role": - "roles/resourcemanager.organizationViewer", - "members": [ "user:eve@example.com" ], - "condition": { "title": "expirable access", - "description": "Does not grant access after - Sep 2020", "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", } } - - ], "etag": "BwWWja0YfJA=", "version": 3 - - } - - **YAML example:** - - bindings: - members: - user:\ mike@example.com - - group:\ admins@example.com - domain:google.com - - serviceAccount:\ my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - user:\ eve@example.com role: - roles/resourcemanager.organizationViewer - condition: title: expirable access description: - Does not grant access after Sep 2020 expression: - request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: - BwWWja0YfJA= version: 3 - - For a description of IAM and its features, see the - [IAM - documentation](\ https://cloud.google.com/iam/docs/). - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([resource]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.SetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.SetIamPolicyRequest() - if resource is not None: - request.resource = resource - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def test_iam_permissions(self, - request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, - *, - resource: Optional[str] = None, - permissions: Optional[MutableSequence[str]] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Tests the access control policy for a billing - account. This method takes the resource and a set of - permissions as input and returns the subset of the input - permissions that the caller is allowed for that - 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 billing_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_test_iam_permissions(): - # Create a client - client = billing_v1.CloudBillingClient() - - # Initialize request argument(s) - request = iam_policy_pb2.TestIamPermissionsRequest( - resource="resource_value", - permissions=['permissions_value1', 'permissions_value2'], - ) - - # Make the request - response = client.test_iam_permissions(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): - The request object. Request message for ``TestIamPermissions`` method. - resource (str): - REQUIRED: The resource for which the - policy detail is being requested. See - the operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - permissions (MutableSequence[str]): - The set of permissions to check for the ``resource``. - Permissions with wildcards (such as '*' or 'storage.*') - are not allowed. For more information see `IAM - Overview `__. - - This corresponds to the ``permissions`` 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.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions 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([resource, permissions]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - if isinstance(request, dict): - # The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.TestIamPermissionsRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.TestIamPermissionsRequest() - if resource is not None: - request.resource = resource - if permissions: - request.permissions.extend(permissions) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "CloudBillingClient": - 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__ = ( - "CloudBillingClient", -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py deleted file mode 100644 index 62cee567d28b..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py +++ /dev/null @@ -1,260 +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.billing_v1.types import cloud_billing - - -class ListBillingAccountsPager: - """A pager for iterating through ``list_billing_accounts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``billing_accounts`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListBillingAccounts`` requests and continue to iterate - through the ``billing_accounts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., cloud_billing.ListBillingAccountsResponse], - request: cloud_billing.ListBillingAccountsRequest, - response: cloud_billing.ListBillingAccountsResponse, - *, - 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.billing_v1.types.ListBillingAccountsRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListBillingAccountsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_billing.ListBillingAccountsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[cloud_billing.ListBillingAccountsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[cloud_billing.BillingAccount]: - for page in self.pages: - yield from page.billing_accounts - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListBillingAccountsAsyncPager: - """A pager for iterating through ``list_billing_accounts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``billing_accounts`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListBillingAccounts`` requests and continue to iterate - through the ``billing_accounts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListBillingAccountsResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[cloud_billing.ListBillingAccountsResponse]], - request: cloud_billing.ListBillingAccountsRequest, - response: cloud_billing.ListBillingAccountsResponse, - *, - 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.billing_v1.types.ListBillingAccountsRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListBillingAccountsResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_billing.ListBillingAccountsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[cloud_billing.ListBillingAccountsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[cloud_billing.BillingAccount]: - async def async_generator(): - async for page in self.pages: - for response in page.billing_accounts: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListProjectBillingInfoPager: - """A pager for iterating through ``list_project_billing_info`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` object, and - provides an ``__iter__`` method to iterate through its - ``project_billing_info`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListProjectBillingInfo`` requests and continue to iterate - through the ``project_billing_info`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., cloud_billing.ListProjectBillingInfoResponse], - request: cloud_billing.ListProjectBillingInfoRequest, - response: cloud_billing.ListProjectBillingInfoResponse, - *, - 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.billing_v1.types.ListProjectBillingInfoRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_billing.ListProjectBillingInfoRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[cloud_billing.ListProjectBillingInfoResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[cloud_billing.ProjectBillingInfo]: - for page in self.pages: - yield from page.project_billing_info - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListProjectBillingInfoAsyncPager: - """A pager for iterating through ``list_project_billing_info`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``project_billing_info`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListProjectBillingInfo`` requests and continue to iterate - through the ``project_billing_info`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListProjectBillingInfoResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[cloud_billing.ListProjectBillingInfoResponse]], - request: cloud_billing.ListProjectBillingInfoRequest, - response: cloud_billing.ListProjectBillingInfoResponse, - *, - 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.billing_v1.types.ListProjectBillingInfoRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_billing.ListProjectBillingInfoRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[cloud_billing.ListProjectBillingInfoResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[cloud_billing.ProjectBillingInfo]: - async def async_generator(): - async for page in self.pages: - for response in page.project_billing_info: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py deleted file mode 100644 index b43a0b23a2ae..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/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 CloudBillingTransport -from .grpc import CloudBillingGrpcTransport -from .grpc_asyncio import CloudBillingGrpcAsyncIOTransport -from .rest import CloudBillingRestTransport -from .rest import CloudBillingRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[CloudBillingTransport]] -_transport_registry['grpc'] = CloudBillingGrpcTransport -_transport_registry['grpc_asyncio'] = CloudBillingGrpcAsyncIOTransport -_transport_registry['rest'] = CloudBillingRestTransport - -__all__ = ( - 'CloudBillingTransport', - 'CloudBillingGrpcTransport', - 'CloudBillingGrpcAsyncIOTransport', - 'CloudBillingRestTransport', - 'CloudBillingRestInterceptor', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py deleted file mode 100644 index 657c5f78e59e..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py +++ /dev/null @@ -1,341 +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.billing_v1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class CloudBillingTransport(abc.ABC): - """Abstract transport class for CloudBilling.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'cloudbilling.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.get_billing_account: gapic_v1.method.wrap_method( - self.get_billing_account, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.list_billing_accounts: gapic_v1.method.wrap_method( - self.list_billing_accounts, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_billing_account: gapic_v1.method.wrap_method( - self.update_billing_account, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.create_billing_account: gapic_v1.method.wrap_method( - self.create_billing_account, - default_timeout=60.0, - client_info=client_info, - ), - self.list_project_billing_info: gapic_v1.method.wrap_method( - self.list_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_project_billing_info: gapic_v1.method.wrap_method( - self.get_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_project_billing_info: gapic_v1.method.wrap_method( - self.update_project_billing_info, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_iam_policy: gapic_v1.method.wrap_method( - self.get_iam_policy, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.set_iam_policy: gapic_v1.method.wrap_method( - self.set_iam_policy, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.test_iam_permissions: gapic_v1.method.wrap_method( - self.test_iam_permissions, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - 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 get_billing_account(self) -> Callable[ - [cloud_billing.GetBillingAccountRequest], - Union[ - cloud_billing.BillingAccount, - Awaitable[cloud_billing.BillingAccount] - ]]: - raise NotImplementedError() - - @property - def list_billing_accounts(self) -> Callable[ - [cloud_billing.ListBillingAccountsRequest], - Union[ - cloud_billing.ListBillingAccountsResponse, - Awaitable[cloud_billing.ListBillingAccountsResponse] - ]]: - raise NotImplementedError() - - @property - def update_billing_account(self) -> Callable[ - [cloud_billing.UpdateBillingAccountRequest], - Union[ - cloud_billing.BillingAccount, - Awaitable[cloud_billing.BillingAccount] - ]]: - raise NotImplementedError() - - @property - def create_billing_account(self) -> Callable[ - [cloud_billing.CreateBillingAccountRequest], - Union[ - cloud_billing.BillingAccount, - Awaitable[cloud_billing.BillingAccount] - ]]: - raise NotImplementedError() - - @property - def list_project_billing_info(self) -> Callable[ - [cloud_billing.ListProjectBillingInfoRequest], - Union[ - cloud_billing.ListProjectBillingInfoResponse, - Awaitable[cloud_billing.ListProjectBillingInfoResponse] - ]]: - raise NotImplementedError() - - @property - def get_project_billing_info(self) -> Callable[ - [cloud_billing.GetProjectBillingInfoRequest], - Union[ - cloud_billing.ProjectBillingInfo, - Awaitable[cloud_billing.ProjectBillingInfo] - ]]: - raise NotImplementedError() - - @property - def update_project_billing_info(self) -> Callable[ - [cloud_billing.UpdateProjectBillingInfoRequest], - Union[ - cloud_billing.ProjectBillingInfo, - Awaitable[cloud_billing.ProjectBillingInfo] - ]]: - raise NotImplementedError() - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Union[ - iam_policy_pb2.TestIamPermissionsResponse, - Awaitable[iam_policy_pb2.TestIamPermissionsResponse] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'CloudBillingTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py deleted file mode 100644 index f9cdc426798c..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py +++ /dev/null @@ -1,578 +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 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.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO - - -class CloudBillingGrpcTransport(CloudBillingTransport): - """gRPC backend transport for CloudBilling. - - Retrieves the Google Cloud Console billing accounts and - associates them with projects. - - 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 = 'cloudbilling.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] = {} - - 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 = 'cloudbilling.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 get_billing_account(self) -> Callable[ - [cloud_billing.GetBillingAccountRequest], - cloud_billing.BillingAccount]: - r"""Return a callable for the get billing account method over gRPC. - - Gets information about a billing account. The current - authenticated user must be a `viewer of the billing - account `__. - - Returns: - Callable[[~.GetBillingAccountRequest], - ~.BillingAccount]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_account' not in self._stubs: - self._stubs['get_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetBillingAccount', - request_serializer=cloud_billing.GetBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['get_billing_account'] - - @property - def list_billing_accounts(self) -> Callable[ - [cloud_billing.ListBillingAccountsRequest], - cloud_billing.ListBillingAccountsResponse]: - r"""Return a callable for the list billing accounts method over gRPC. - - Lists the billing accounts that the current authenticated user - has permission to - `view `__. - - Returns: - Callable[[~.ListBillingAccountsRequest], - ~.ListBillingAccountsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_accounts' not in self._stubs: - self._stubs['list_billing_accounts'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/ListBillingAccounts', - request_serializer=cloud_billing.ListBillingAccountsRequest.serialize, - response_deserializer=cloud_billing.ListBillingAccountsResponse.deserialize, - ) - return self._stubs['list_billing_accounts'] - - @property - def update_billing_account(self) -> Callable[ - [cloud_billing.UpdateBillingAccountRequest], - cloud_billing.BillingAccount]: - r"""Return a callable for the update billing account method over gRPC. - - Updates a billing account's fields. Currently the only field - that can be edited is ``display_name``. The current - authenticated user must have the ``billing.accounts.update`` IAM - permission, which is typically given to the - `administrator `__ - of the billing account. - - Returns: - Callable[[~.UpdateBillingAccountRequest], - ~.BillingAccount]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_account' not in self._stubs: - self._stubs['update_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/UpdateBillingAccount', - request_serializer=cloud_billing.UpdateBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['update_billing_account'] - - @property - def create_billing_account(self) -> Callable[ - [cloud_billing.CreateBillingAccountRequest], - cloud_billing.BillingAccount]: - r"""Return a callable for the create billing account method over gRPC. - - This method creates `billing - subaccounts `__. - - Google Cloud resellers should use the Channel Services APIs, - `accounts.customers.create `__ - and - `accounts.customers.entitlements.create `__. - - When creating a subaccount, the current authenticated user must - have the ``billing.accounts.update`` IAM permission on the - parent account, which is typically given to billing account - `administrators `__. - This method will return an error if the parent account has not - been provisioned as a reseller account. - - Returns: - Callable[[~.CreateBillingAccountRequest], - ~.BillingAccount]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_billing_account' not in self._stubs: - self._stubs['create_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/CreateBillingAccount', - request_serializer=cloud_billing.CreateBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['create_billing_account'] - - @property - def list_project_billing_info(self) -> Callable[ - [cloud_billing.ListProjectBillingInfoRequest], - cloud_billing.ListProjectBillingInfoResponse]: - r"""Return a callable for the list project billing info method over gRPC. - - Lists the projects associated with a billing account. The - current authenticated user must have the - ``billing.resourceAssociations.list`` IAM permission, which is - often given to billing account - `viewers `__. - - Returns: - Callable[[~.ListProjectBillingInfoRequest], - ~.ListProjectBillingInfoResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['list_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/ListProjectBillingInfo', - request_serializer=cloud_billing.ListProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ListProjectBillingInfoResponse.deserialize, - ) - return self._stubs['list_project_billing_info'] - - @property - def get_project_billing_info(self) -> Callable[ - [cloud_billing.GetProjectBillingInfoRequest], - cloud_billing.ProjectBillingInfo]: - r"""Return a callable for the get project billing info method over gRPC. - - Gets the billing information for a project. The current - authenticated user must have the - ``resourcemanager.projects.get`` permission for the project, - which can be granted by assigning the `Project - Viewer `__ - role. - - Returns: - Callable[[~.GetProjectBillingInfoRequest], - ~.ProjectBillingInfo]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['get_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetProjectBillingInfo', - request_serializer=cloud_billing.GetProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, - ) - return self._stubs['get_project_billing_info'] - - @property - def update_project_billing_info(self) -> Callable[ - [cloud_billing.UpdateProjectBillingInfoRequest], - cloud_billing.ProjectBillingInfo]: - r"""Return a callable for the update project billing info method over gRPC. - - Sets or updates the billing account associated with a project. - You specify the new billing account by setting the - ``billing_account_name`` in the ``ProjectBillingInfo`` resource - to the resource name of a billing account. Associating a project - with an open billing account enables billing on the project and - allows charges for resource usage. If the project already had a - billing account, this method changes the billing account used - for resource usage charges. - - *Note:* Incurred charges that have not yet been reported in the - transaction history of the Google Cloud Console might be billed - to the new billing account, even if the charge occurred before - the new billing account was assigned to the project. - - The current authenticated user must have ownership privileges - for both the - `project `__ - and the `billing - account `__. - - You can disable billing on the project by setting the - ``billing_account_name`` field to empty. This action - disassociates the current billing account from the project. Any - billable activity of your in-use services will stop, and your - application could stop functioning as expected. Any unbilled - charges to date will be billed to the previously associated - account. The current authenticated user must be either an owner - of the project or an owner of the billing account for the - project. - - Note that associating a project with a *closed* billing account - will have much the same effect as disabling billing on the - project: any paid resources used by the project will be shut - down. Thus, unless you wish to disable billing, you should - always call this method with the name of an *open* billing - account. - - Returns: - Callable[[~.UpdateProjectBillingInfoRequest], - ~.ProjectBillingInfo]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['update_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/UpdateProjectBillingInfo', - request_serializer=cloud_billing.UpdateProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, - ) - return self._stubs['update_project_billing_info'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a billing account. The caller - must have the ``billing.accounts.getIamPolicy`` permission on - the account, which is often given to billing account - `viewers `__. - - Returns: - Callable[[~.GetIamPolicyRequest], - ~.Policy]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets the access control policy for a billing account. Replaces - any existing policy. The caller must have the - ``billing.accounts.setIamPolicy`` permission on the account, - which is often given to billing account - `administrators `__. - - Returns: - Callable[[~.SetIamPolicyRequest], - ~.Policy]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - iam_policy_pb2.TestIamPermissionsResponse]: - r"""Return a callable for the test iam permissions method over gRPC. - - Tests the access control policy for a billing - account. This method takes the resource and a set of - permissions as input and returns the subset of the input - permissions that the caller is allowed for that - resource. - - Returns: - Callable[[~.TestIamPermissionsRequest], - ~.TestIamPermissionsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'CloudBillingGrpcTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py deleted file mode 100644 index cd0e9889c83a..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py +++ /dev/null @@ -1,577 +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.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.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO -from .grpc import CloudBillingGrpcTransport - - -class CloudBillingGrpcAsyncIOTransport(CloudBillingTransport): - """gRPC AsyncIO backend transport for CloudBilling. - - Retrieves the Google Cloud Console billing accounts and - associates them with projects. - - 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 = 'cloudbilling.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 = 'cloudbilling.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] = {} - - 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 get_billing_account(self) -> Callable[ - [cloud_billing.GetBillingAccountRequest], - Awaitable[cloud_billing.BillingAccount]]: - r"""Return a callable for the get billing account method over gRPC. - - Gets information about a billing account. The current - authenticated user must be a `viewer of the billing - account `__. - - Returns: - Callable[[~.GetBillingAccountRequest], - Awaitable[~.BillingAccount]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_account' not in self._stubs: - self._stubs['get_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetBillingAccount', - request_serializer=cloud_billing.GetBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['get_billing_account'] - - @property - def list_billing_accounts(self) -> Callable[ - [cloud_billing.ListBillingAccountsRequest], - Awaitable[cloud_billing.ListBillingAccountsResponse]]: - r"""Return a callable for the list billing accounts method over gRPC. - - Lists the billing accounts that the current authenticated user - has permission to - `view `__. - - Returns: - Callable[[~.ListBillingAccountsRequest], - Awaitable[~.ListBillingAccountsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_accounts' not in self._stubs: - self._stubs['list_billing_accounts'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/ListBillingAccounts', - request_serializer=cloud_billing.ListBillingAccountsRequest.serialize, - response_deserializer=cloud_billing.ListBillingAccountsResponse.deserialize, - ) - return self._stubs['list_billing_accounts'] - - @property - def update_billing_account(self) -> Callable[ - [cloud_billing.UpdateBillingAccountRequest], - Awaitable[cloud_billing.BillingAccount]]: - r"""Return a callable for the update billing account method over gRPC. - - Updates a billing account's fields. Currently the only field - that can be edited is ``display_name``. The current - authenticated user must have the ``billing.accounts.update`` IAM - permission, which is typically given to the - `administrator `__ - of the billing account. - - Returns: - Callable[[~.UpdateBillingAccountRequest], - Awaitable[~.BillingAccount]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_billing_account' not in self._stubs: - self._stubs['update_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/UpdateBillingAccount', - request_serializer=cloud_billing.UpdateBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['update_billing_account'] - - @property - def create_billing_account(self) -> Callable[ - [cloud_billing.CreateBillingAccountRequest], - Awaitable[cloud_billing.BillingAccount]]: - r"""Return a callable for the create billing account method over gRPC. - - This method creates `billing - subaccounts `__. - - Google Cloud resellers should use the Channel Services APIs, - `accounts.customers.create `__ - and - `accounts.customers.entitlements.create `__. - - When creating a subaccount, the current authenticated user must - have the ``billing.accounts.update`` IAM permission on the - parent account, which is typically given to billing account - `administrators `__. - This method will return an error if the parent account has not - been provisioned as a reseller account. - - Returns: - Callable[[~.CreateBillingAccountRequest], - Awaitable[~.BillingAccount]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_billing_account' not in self._stubs: - self._stubs['create_billing_account'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/CreateBillingAccount', - request_serializer=cloud_billing.CreateBillingAccountRequest.serialize, - response_deserializer=cloud_billing.BillingAccount.deserialize, - ) - return self._stubs['create_billing_account'] - - @property - def list_project_billing_info(self) -> Callable[ - [cloud_billing.ListProjectBillingInfoRequest], - Awaitable[cloud_billing.ListProjectBillingInfoResponse]]: - r"""Return a callable for the list project billing info method over gRPC. - - Lists the projects associated with a billing account. The - current authenticated user must have the - ``billing.resourceAssociations.list`` IAM permission, which is - often given to billing account - `viewers `__. - - Returns: - Callable[[~.ListProjectBillingInfoRequest], - Awaitable[~.ListProjectBillingInfoResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['list_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/ListProjectBillingInfo', - request_serializer=cloud_billing.ListProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ListProjectBillingInfoResponse.deserialize, - ) - return self._stubs['list_project_billing_info'] - - @property - def get_project_billing_info(self) -> Callable[ - [cloud_billing.GetProjectBillingInfoRequest], - Awaitable[cloud_billing.ProjectBillingInfo]]: - r"""Return a callable for the get project billing info method over gRPC. - - Gets the billing information for a project. The current - authenticated user must have the - ``resourcemanager.projects.get`` permission for the project, - which can be granted by assigning the `Project - Viewer `__ - role. - - Returns: - Callable[[~.GetProjectBillingInfoRequest], - Awaitable[~.ProjectBillingInfo]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['get_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetProjectBillingInfo', - request_serializer=cloud_billing.GetProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, - ) - return self._stubs['get_project_billing_info'] - - @property - def update_project_billing_info(self) -> Callable[ - [cloud_billing.UpdateProjectBillingInfoRequest], - Awaitable[cloud_billing.ProjectBillingInfo]]: - r"""Return a callable for the update project billing info method over gRPC. - - Sets or updates the billing account associated with a project. - You specify the new billing account by setting the - ``billing_account_name`` in the ``ProjectBillingInfo`` resource - to the resource name of a billing account. Associating a project - with an open billing account enables billing on the project and - allows charges for resource usage. If the project already had a - billing account, this method changes the billing account used - for resource usage charges. - - *Note:* Incurred charges that have not yet been reported in the - transaction history of the Google Cloud Console might be billed - to the new billing account, even if the charge occurred before - the new billing account was assigned to the project. - - The current authenticated user must have ownership privileges - for both the - `project `__ - and the `billing - account `__. - - You can disable billing on the project by setting the - ``billing_account_name`` field to empty. This action - disassociates the current billing account from the project. Any - billable activity of your in-use services will stop, and your - application could stop functioning as expected. Any unbilled - charges to date will be billed to the previously associated - account. The current authenticated user must be either an owner - of the project or an owner of the billing account for the - project. - - Note that associating a project with a *closed* billing account - will have much the same effect as disabling billing on the - project: any paid resources used by the project will be shut - down. Thus, unless you wish to disable billing, you should - always call this method with the name of an *open* billing - account. - - Returns: - Callable[[~.UpdateProjectBillingInfoRequest], - Awaitable[~.ProjectBillingInfo]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_project_billing_info' not in self._stubs: - self._stubs['update_project_billing_info'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/UpdateProjectBillingInfo', - request_serializer=cloud_billing.UpdateProjectBillingInfoRequest.serialize, - response_deserializer=cloud_billing.ProjectBillingInfo.deserialize, - ) - return self._stubs['update_project_billing_info'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a billing account. The caller - must have the ``billing.accounts.getIamPolicy`` permission on - the account, which is often given to billing account - `viewers `__. - - Returns: - Callable[[~.GetIamPolicyRequest], - Awaitable[~.Policy]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets the access control policy for a billing account. Replaces - any existing policy. The caller must have the - ``billing.accounts.setIamPolicy`` permission on the account, - which is often given to billing account - `administrators `__. - - Returns: - Callable[[~.SetIamPolicyRequest], - Awaitable[~.Policy]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: - r"""Return a callable for the test iam permissions method over gRPC. - - Tests the access control policy for a billing - account. This method takes the resource and a set of - permissions as input and returns the subset of the input - permissions that the caller is allowed for that - resource. - - Returns: - Callable[[~.TestIamPermissionsRequest], - Awaitable[~.TestIamPermissionsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudBilling/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'CloudBillingGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py deleted file mode 100644 index 120ad64b45af..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_billing/transports/rest.py +++ /dev/null @@ -1,1490 +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 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.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore - -from .base import CloudBillingTransport, 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 CloudBillingRestInterceptor: - """Interceptor for CloudBilling. - - 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 CloudBillingRestTransport. - - .. code-block:: python - class MyCustomCloudBillingInterceptor(CloudBillingRestInterceptor): - def pre_create_billing_account(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_billing_account(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_billing_account(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_billing_account(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_iam_policy(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_iam_policy(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_project_billing_info(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_project_billing_info(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_billing_accounts(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_billing_accounts(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_project_billing_info(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_project_billing_info(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_iam_policy(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_iam_policy(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_test_iam_permissions(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_test_iam_permissions(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_billing_account(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_billing_account(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_project_billing_info(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_project_billing_info(self, response): - logging.log(f"Received response: {response}") - return response - - transport = CloudBillingRestTransport(interceptor=MyCustomCloudBillingInterceptor()) - client = CloudBillingClient(transport=transport) - - - """ - def pre_create_billing_account(self, request: cloud_billing.CreateBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.CreateBillingAccountRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for create_billing_account - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_create_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: - """Post-rpc interceptor for create_billing_account - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_get_billing_account(self, request: cloud_billing.GetBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.GetBillingAccountRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_billing_account - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_get_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: - """Post-rpc interceptor for get_billing_account - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_get_iam_policy(self, request: iam_policy_pb2.GetIamPolicyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_iam_policy - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: - """Post-rpc interceptor for get_iam_policy - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_get_project_billing_info(self, request: cloud_billing.GetProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.GetProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_project_billing_info - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_get_project_billing_info(self, response: cloud_billing.ProjectBillingInfo) -> cloud_billing.ProjectBillingInfo: - """Post-rpc interceptor for get_project_billing_info - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_list_billing_accounts(self, request: cloud_billing.ListBillingAccountsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.ListBillingAccountsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_billing_accounts - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_list_billing_accounts(self, response: cloud_billing.ListBillingAccountsResponse) -> cloud_billing.ListBillingAccountsResponse: - """Post-rpc interceptor for list_billing_accounts - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_list_project_billing_info(self, request: cloud_billing.ListProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.ListProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_project_billing_info - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_list_project_billing_info(self, response: cloud_billing.ListProjectBillingInfoResponse) -> cloud_billing.ListProjectBillingInfoResponse: - """Post-rpc interceptor for list_project_billing_info - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_set_iam_policy(self, request: iam_policy_pb2.SetIamPolicyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for set_iam_policy - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: - """Post-rpc interceptor for set_iam_policy - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_test_iam_permissions(self, request: iam_policy_pb2.TestIamPermissionsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for test_iam_permissions - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_test_iam_permissions(self, response: iam_policy_pb2.TestIamPermissionsResponse) -> iam_policy_pb2.TestIamPermissionsResponse: - """Post-rpc interceptor for test_iam_permissions - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_update_billing_account(self, request: cloud_billing.UpdateBillingAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.UpdateBillingAccountRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_billing_account - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_update_billing_account(self, response: cloud_billing.BillingAccount) -> cloud_billing.BillingAccount: - """Post-rpc interceptor for update_billing_account - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - def pre_update_project_billing_info(self, request: cloud_billing.UpdateProjectBillingInfoRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_billing.UpdateProjectBillingInfoRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_project_billing_info - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudBilling server. - """ - return request, metadata - - def post_update_project_billing_info(self, response: cloud_billing.ProjectBillingInfo) -> cloud_billing.ProjectBillingInfo: - """Post-rpc interceptor for update_project_billing_info - - Override in a subclass to manipulate the response - after it is returned by the CloudBilling server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class CloudBillingRestStub: - _session: AuthorizedSession - _host: str - _interceptor: CloudBillingRestInterceptor - - -class CloudBillingRestTransport(CloudBillingTransport): - """REST backend transport for CloudBilling. - - Retrieves the Google Cloud Console billing accounts and - associates them with projects. - - 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 = 'cloudbilling.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[CloudBillingRestInterceptor] = 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) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or CloudBillingRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _CreateBillingAccount(CloudBillingRestStub): - def __hash__(self): - return hash("CreateBillingAccount") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.CreateBillingAccountRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.BillingAccount: - r"""Call the create billing account method over HTTP. - - Args: - request (~.cloud_billing.CreateBillingAccountRequest): - The request object. Request message for ``CreateBillingAccount``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.BillingAccount: - A billing account in the `Google Cloud - Console `__. You can - assign a billing account to one or more projects. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/billingAccounts', - 'body': 'billing_account', - }, - ] - request, metadata = self._interceptor.pre_create_billing_account(request, metadata) - pb_request = cloud_billing.CreateBillingAccountRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.BillingAccount() - pb_resp = cloud_billing.BillingAccount.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_create_billing_account(resp) - return resp - - class _GetBillingAccount(CloudBillingRestStub): - def __hash__(self): - return hash("GetBillingAccount") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.GetBillingAccountRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.BillingAccount: - r"""Call the get billing account method over HTTP. - - Args: - request (~.cloud_billing.GetBillingAccountRequest): - The request object. Request message for ``GetBillingAccount``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.BillingAccount: - A billing account in the `Google Cloud - Console `__. You can - assign a billing account to one or more projects. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=billingAccounts/*}', - }, - ] - request, metadata = self._interceptor.pre_get_billing_account(request, metadata) - pb_request = cloud_billing.GetBillingAccountRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.BillingAccount() - pb_resp = cloud_billing.BillingAccount.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_billing_account(resp) - return resp - - class _GetIamPolicy(CloudBillingRestStub): - def __hash__(self): - return hash("GetIamPolicy") - - __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: iam_policy_pb2.GetIamPolicyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> policy_pb2.Policy: - r"""Call the get iam policy method over HTTP. - - Args: - request (~.iam_policy_pb2.GetIamPolicyRequest): - The request object. Request message for ``GetIamPolicy`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which - specifies access controls for Google Cloud resources. - - A ``Policy`` is a collection of ``bindings``. A - ``binding`` binds one or more ``members``, or - principals, to a single ``role``. Principals can be user - accounts, service accounts, Google groups, and domains - (such as G Suite). A ``role`` is a named list of - permissions; each ``role`` can be an IAM predefined role - or a user-created custom role. - - For some types of Google Cloud resources, a ``binding`` - can also specify a ``condition``, which is a logical - expression that allows access to a resource only if the - expression evaluates to ``true``. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the `IAM - documentation `__. - - **JSON example:** - - :: - - { - "bindings": [ - { - "role": "roles/resourcemanager.organizationAdmin", - "members": [ - "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - }, - { - "role": "roles/resourcemanager.organizationViewer", - "members": [ - "user:eve@example.com" - ], - "condition": { - "title": "expirable access", - "description": "Does not grant access after Sep 2020", - "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", - } - } - ], - "etag": "BwWWja0YfJA=", - "version": 3 - } - - **YAML example:** - - :: - - bindings: - - members: - - user:mike@example.com - - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - - user:eve@example.com - role: roles/resourcemanager.organizationViewer - condition: - title: expirable access - description: Does not grant access after Sep 2020 - expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 - - For a description of IAM and its features, see the `IAM - documentation `__. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{resource=billingAccounts/*}:getIamPolicy', - }, - ] - request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) - pb_request = 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 = policy_pb2.Policy() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_iam_policy(resp) - return resp - - class _GetProjectBillingInfo(CloudBillingRestStub): - def __hash__(self): - return hash("GetProjectBillingInfo") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.GetProjectBillingInfoRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.ProjectBillingInfo: - r"""Call the get project billing info method over HTTP. - - Args: - request (~.cloud_billing.GetProjectBillingInfoRequest): - The request object. Request message for ``GetProjectBillingInfo``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*}/billingInfo', - }, - ] - request, metadata = self._interceptor.pre_get_project_billing_info(request, metadata) - pb_request = cloud_billing.GetProjectBillingInfoRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.ProjectBillingInfo() - pb_resp = cloud_billing.ProjectBillingInfo.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_project_billing_info(resp) - return resp - - class _ListBillingAccounts(CloudBillingRestStub): - def __hash__(self): - return hash("ListBillingAccounts") - - def __call__(self, - request: cloud_billing.ListBillingAccountsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.ListBillingAccountsResponse: - r"""Call the list billing accounts method over HTTP. - - Args: - request (~.cloud_billing.ListBillingAccountsRequest): - The request object. Request message for ``ListBillingAccounts``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.ListBillingAccountsResponse: - Response message for ``ListBillingAccounts``. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/billingAccounts', - }, - ] - request, metadata = self._interceptor.pre_list_billing_accounts(request, metadata) - pb_request = cloud_billing.ListBillingAccountsRequest.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["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.ListBillingAccountsResponse() - pb_resp = cloud_billing.ListBillingAccountsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_billing_accounts(resp) - return resp - - class _ListProjectBillingInfo(CloudBillingRestStub): - def __hash__(self): - return hash("ListProjectBillingInfo") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.ListProjectBillingInfoRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.ListProjectBillingInfoResponse: - r"""Call the list project billing info method over HTTP. - - Args: - request (~.cloud_billing.ListProjectBillingInfoRequest): - The request object. Request message for ``ListProjectBillingInfo``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.ListProjectBillingInfoResponse: - Request message for ``ListProjectBillingInfoResponse``. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=billingAccounts/*}/projects', - }, - ] - request, metadata = self._interceptor.pre_list_project_billing_info(request, metadata) - pb_request = cloud_billing.ListProjectBillingInfoRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.ListProjectBillingInfoResponse() - pb_resp = cloud_billing.ListProjectBillingInfoResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_project_billing_info(resp) - return resp - - class _SetIamPolicy(CloudBillingRestStub): - def __hash__(self): - return hash("SetIamPolicy") - - __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: iam_policy_pb2.SetIamPolicyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> policy_pb2.Policy: - r"""Call the set iam policy method over HTTP. - - Args: - request (~.iam_policy_pb2.SetIamPolicyRequest): - The request object. Request message for ``SetIamPolicy`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which - specifies access controls for Google Cloud resources. - - A ``Policy`` is a collection of ``bindings``. A - ``binding`` binds one or more ``members``, or - principals, to a single ``role``. Principals can be user - accounts, service accounts, Google groups, and domains - (such as G Suite). A ``role`` is a named list of - permissions; each ``role`` can be an IAM predefined role - or a user-created custom role. - - For some types of Google Cloud resources, a ``binding`` - can also specify a ``condition``, which is a logical - expression that allows access to a resource only if the - expression evaluates to ``true``. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the `IAM - documentation `__. - - **JSON example:** - - :: - - { - "bindings": [ - { - "role": "roles/resourcemanager.organizationAdmin", - "members": [ - "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - }, - { - "role": "roles/resourcemanager.organizationViewer", - "members": [ - "user:eve@example.com" - ], - "condition": { - "title": "expirable access", - "description": "Does not grant access after Sep 2020", - "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", - } - } - ], - "etag": "BwWWja0YfJA=", - "version": 3 - } - - **YAML example:** - - :: - - bindings: - - members: - - user:mike@example.com - - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - - user:eve@example.com - role: roles/resourcemanager.organizationViewer - condition: - title: expirable access - description: Does not grant access after Sep 2020 - expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 - - For a description of IAM and its features, see the `IAM - documentation `__. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{resource=billingAccounts/*}:setIamPolicy', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) - pb_request = 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 = policy_pb2.Policy() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_set_iam_policy(resp) - return resp - - class _TestIamPermissions(CloudBillingRestStub): - def __hash__(self): - return hash("TestIamPermissions") - - __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: iam_policy_pb2.TestIamPermissionsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Call the test iam permissions method over HTTP. - - Args: - request (~.iam_policy_pb2.TestIamPermissionsRequest): - The request object. Request message for ``TestIamPermissions`` method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.iam_policy_pb2.TestIamPermissionsResponse: - Response message for ``TestIamPermissions`` method. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{resource=billingAccounts/*}:testIamPermissions', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_test_iam_permissions(request, metadata) - pb_request = 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 = iam_policy_pb2.TestIamPermissionsResponse() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_test_iam_permissions(resp) - return resp - - class _UpdateBillingAccount(CloudBillingRestStub): - def __hash__(self): - return hash("UpdateBillingAccount") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.UpdateBillingAccountRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.BillingAccount: - r"""Call the update billing account method over HTTP. - - Args: - request (~.cloud_billing.UpdateBillingAccountRequest): - The request object. Request message for ``UpdateBillingAccount``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.BillingAccount: - A billing account in the `Google Cloud - Console `__. You can - assign a billing account to one or more projects. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{name=billingAccounts/*}', - 'body': 'account', - }, - ] - request, metadata = self._interceptor.pre_update_billing_account(request, metadata) - pb_request = cloud_billing.UpdateBillingAccountRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.BillingAccount() - pb_resp = cloud_billing.BillingAccount.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_billing_account(resp) - return resp - - class _UpdateProjectBillingInfo(CloudBillingRestStub): - def __hash__(self): - return hash("UpdateProjectBillingInfo") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_billing.UpdateProjectBillingInfoRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_billing.ProjectBillingInfo: - r"""Call the update project billing - info method over HTTP. - - Args: - request (~.cloud_billing.UpdateProjectBillingInfoRequest): - The request object. Request message for ``UpdateProjectBillingInfo``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_billing.ProjectBillingInfo: - Encapsulation of billing information - for a Google Cloud Console project. A - project has at most one associated - billing account at a time (but a billing - account can be assigned to multiple - projects). - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v1/{name=projects/*}/billingInfo', - 'body': 'project_billing_info', - }, - ] - request, metadata = self._interceptor.pre_update_project_billing_info(request, metadata) - pb_request = cloud_billing.UpdateProjectBillingInfoRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_billing.ProjectBillingInfo() - pb_resp = cloud_billing.ProjectBillingInfo.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_project_billing_info(resp) - return resp - - @property - def create_billing_account(self) -> Callable[ - [cloud_billing.CreateBillingAccountRequest], - cloud_billing.BillingAccount]: - # 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._CreateBillingAccount(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_billing_account(self) -> Callable[ - [cloud_billing.GetBillingAccountRequest], - cloud_billing.BillingAccount]: - # 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._GetBillingAccount(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - policy_pb2.Policy]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_project_billing_info(self) -> Callable[ - [cloud_billing.GetProjectBillingInfoRequest], - cloud_billing.ProjectBillingInfo]: - # 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._GetProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_billing_accounts(self) -> Callable[ - [cloud_billing.ListBillingAccountsRequest], - cloud_billing.ListBillingAccountsResponse]: - # 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._ListBillingAccounts(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_project_billing_info(self) -> Callable[ - [cloud_billing.ListProjectBillingInfoRequest], - cloud_billing.ListProjectBillingInfoResponse]: - # 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._ListProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - policy_pb2.Policy]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - iam_policy_pb2.TestIamPermissionsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_billing_account(self) -> Callable[ - [cloud_billing.UpdateBillingAccountRequest], - cloud_billing.BillingAccount]: - # 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._UpdateBillingAccount(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_project_billing_info(self) -> Callable[ - [cloud_billing.UpdateProjectBillingInfoRequest], - cloud_billing.ProjectBillingInfo]: - # 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._UpdateProjectBillingInfo(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'CloudBillingRestTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py deleted file mode 100644 index 837679acc7ed..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/__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 CloudCatalogClient -from .async_client import CloudCatalogAsyncClient - -__all__ = ( - 'CloudCatalogClient', - 'CloudCatalogAsyncClient', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py deleted file mode 100644 index 20464a919d01..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py +++ /dev/null @@ -1,399 +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.billing_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.cloud.billing_v1.services.cloud_catalog import pagers -from google.cloud.billing_v1.types import cloud_catalog -from .transports.base import CloudCatalogTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import CloudCatalogGrpcAsyncIOTransport -from .client import CloudCatalogClient - - -class CloudCatalogAsyncClient: - """A catalog of Google Cloud Platform services and SKUs. - Provides pricing information and metadata on Google Cloud - Platform services and SKUs. - """ - - _client: CloudCatalogClient - - DEFAULT_ENDPOINT = CloudCatalogClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = CloudCatalogClient.DEFAULT_MTLS_ENDPOINT - - service_path = staticmethod(CloudCatalogClient.service_path) - parse_service_path = staticmethod(CloudCatalogClient.parse_service_path) - sku_path = staticmethod(CloudCatalogClient.sku_path) - parse_sku_path = staticmethod(CloudCatalogClient.parse_sku_path) - common_billing_account_path = staticmethod(CloudCatalogClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(CloudCatalogClient.parse_common_billing_account_path) - common_folder_path = staticmethod(CloudCatalogClient.common_folder_path) - parse_common_folder_path = staticmethod(CloudCatalogClient.parse_common_folder_path) - common_organization_path = staticmethod(CloudCatalogClient.common_organization_path) - parse_common_organization_path = staticmethod(CloudCatalogClient.parse_common_organization_path) - common_project_path = staticmethod(CloudCatalogClient.common_project_path) - parse_common_project_path = staticmethod(CloudCatalogClient.parse_common_project_path) - common_location_path = staticmethod(CloudCatalogClient.common_location_path) - parse_common_location_path = staticmethod(CloudCatalogClient.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: - CloudCatalogAsyncClient: The constructed client. - """ - return CloudCatalogClient.from_service_account_info.__func__(CloudCatalogAsyncClient, 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: - CloudCatalogAsyncClient: The constructed client. - """ - return CloudCatalogClient.from_service_account_file.__func__(CloudCatalogAsyncClient, 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 CloudCatalogClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> CloudCatalogTransport: - """Returns the transport used by the client instance. - - Returns: - CloudCatalogTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(CloudCatalogClient).get_transport_class, type(CloudCatalogClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, CloudCatalogTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the cloud catalog 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, ~.CloudCatalogTransport]): 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 = CloudCatalogClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def list_services(self, - request: Optional[Union[cloud_catalog.ListServicesRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListServicesAsyncPager: - r"""Lists all public cloud services. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_list_services(): - # Create a client - client = billing_v1.CloudCatalogAsyncClient() - - # Initialize request argument(s) - request = billing_v1.ListServicesRequest( - ) - - # Make the request - page_result = client.list_services(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.ListServicesRequest, dict]]): - The request object. Request message for ``ListServices``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager: - Response message for ListServices. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - request = cloud_catalog.ListServicesRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_services, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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.ListServicesAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_skus(self, - request: Optional[Union[cloud_catalog.ListSkusRequest, 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.ListSkusAsyncPager: - r"""Lists all publicly available SKUs for a given cloud - service. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - async def sample_list_skus(): - # Create a client - client = billing_v1.CloudCatalogAsyncClient() - - # Initialize request argument(s) - request = billing_v1.ListSkusRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_skus(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.billing_v1.types.ListSkusRequest, dict]]): - The request object. Request message for ``ListSkus``. - parent (:class:`str`): - Required. The name of the service. - Example: "services/DA34-426B-A397" - - 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.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager: - Response message for ListSkus. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = cloud_catalog.ListSkusRequest(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_skus, - default_timeout=60.0, - 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.ListSkusAsyncPager( - method=rpc, - request=request, - response=response, - 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__ = ( - "CloudCatalogAsyncClient", -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py deleted file mode 100644 index 80a18d0f9bcb..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/client.py +++ /dev/null @@ -1,613 +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.billing_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.cloud.billing_v1.services.cloud_catalog import pagers -from google.cloud.billing_v1.types import cloud_catalog -from .transports.base import CloudCatalogTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import CloudCatalogGrpcTransport -from .transports.grpc_asyncio import CloudCatalogGrpcAsyncIOTransport -from .transports.rest import CloudCatalogRestTransport - - -class CloudCatalogClientMeta(type): - """Metaclass for the CloudCatalog 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[CloudCatalogTransport]] - _transport_registry["grpc"] = CloudCatalogGrpcTransport - _transport_registry["grpc_asyncio"] = CloudCatalogGrpcAsyncIOTransport - _transport_registry["rest"] = CloudCatalogRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[CloudCatalogTransport]: - """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 CloudCatalogClient(metaclass=CloudCatalogClientMeta): - """A catalog of Google Cloud Platform services and SKUs. - Provides pricing information and metadata on Google Cloud - Platform services and SKUs. - """ - - @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 = "cloudbilling.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: - CloudCatalogClient: 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: - CloudCatalogClient: 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) -> CloudCatalogTransport: - """Returns the transport used by the client instance. - - Returns: - CloudCatalogTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def service_path(service: str,) -> str: - """Returns a fully-qualified service string.""" - return "services/{service}".format(service=service, ) - - @staticmethod - def parse_service_path(path: str) -> Dict[str,str]: - """Parses a service path into its component segments.""" - m = re.match(r"^services/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def sku_path(service: str,sku: str,) -> str: - """Returns a fully-qualified sku string.""" - return "services/{service}/skus/{sku}".format(service=service, sku=sku, ) - - @staticmethod - def parse_sku_path(path: str) -> Dict[str,str]: - """Parses a sku path into its component segments.""" - m = re.match(r"^services/(?P.+?)/skus/(?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, CloudCatalogTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the cloud catalog 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, CloudCatalogTransport]): 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, CloudCatalogTransport): - # transport is a CloudCatalogTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def list_services(self, - request: Optional[Union[cloud_catalog.ListServicesRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListServicesPager: - r"""Lists all public cloud services. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_list_services(): - # Create a client - client = billing_v1.CloudCatalogClient() - - # Initialize request argument(s) - request = billing_v1.ListServicesRequest( - ) - - # Make the request - page_result = client.list_services(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.ListServicesRequest, dict]): - The request object. Request message for ``ListServices``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - 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.billing_v1.services.cloud_catalog.pagers.ListServicesPager: - Response message for ListServices. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a cloud_catalog.ListServicesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_catalog.ListServicesRequest): - request = cloud_catalog.ListServicesRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_services] - - # 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.ListServicesPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_skus(self, - request: Optional[Union[cloud_catalog.ListSkusRequest, 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.ListSkusPager: - r"""Lists all publicly available SKUs for a given cloud - service. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import billing_v1 - - def sample_list_skus(): - # Create a client - client = billing_v1.CloudCatalogClient() - - # Initialize request argument(s) - request = billing_v1.ListSkusRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_skus(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.billing_v1.types.ListSkusRequest, dict]): - The request object. Request message for ``ListSkus``. - parent (str): - Required. The name of the service. - Example: "services/DA34-426B-A397" - - 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.billing_v1.services.cloud_catalog.pagers.ListSkusPager: - Response message for ListSkus. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a cloud_catalog.ListSkusRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_catalog.ListSkusRequest): - request = cloud_catalog.ListSkusRequest(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_skus] - - # 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.ListSkusPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "CloudCatalogClient": - 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__ = ( - "CloudCatalogClient", -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py deleted file mode 100644 index 6faee2d8cc0e..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py +++ /dev/null @@ -1,260 +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.billing_v1.types import cloud_catalog - - -class ListServicesPager: - """A pager for iterating through ``list_services`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListServicesResponse` object, and - provides an ``__iter__`` method to iterate through its - ``services`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListServices`` requests and continue to iterate - through the ``services`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListServicesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., cloud_catalog.ListServicesResponse], - request: cloud_catalog.ListServicesRequest, - response: cloud_catalog.ListServicesResponse, - *, - 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.billing_v1.types.ListServicesRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListServicesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_catalog.ListServicesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[cloud_catalog.ListServicesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[cloud_catalog.Service]: - for page in self.pages: - yield from page.services - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListServicesAsyncPager: - """A pager for iterating through ``list_services`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListServicesResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``services`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListServices`` requests and continue to iterate - through the ``services`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListServicesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[cloud_catalog.ListServicesResponse]], - request: cloud_catalog.ListServicesRequest, - response: cloud_catalog.ListServicesResponse, - *, - 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.billing_v1.types.ListServicesRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListServicesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_catalog.ListServicesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[cloud_catalog.ListServicesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[cloud_catalog.Service]: - async def async_generator(): - async for page in self.pages: - for response in page.services: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListSkusPager: - """A pager for iterating through ``list_skus`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListSkusResponse` object, and - provides an ``__iter__`` method to iterate through its - ``skus`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListSkus`` requests and continue to iterate - through the ``skus`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListSkusResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., cloud_catalog.ListSkusResponse], - request: cloud_catalog.ListSkusRequest, - response: cloud_catalog.ListSkusResponse, - *, - 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.billing_v1.types.ListSkusRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListSkusResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_catalog.ListSkusRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[cloud_catalog.ListSkusResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[cloud_catalog.Sku]: - for page in self.pages: - yield from page.skus - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListSkusAsyncPager: - """A pager for iterating through ``list_skus`` requests. - - This class thinly wraps an initial - :class:`google.cloud.billing_v1.types.ListSkusResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``skus`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListSkus`` requests and continue to iterate - through the ``skus`` field on the - corresponding responses. - - All the usual :class:`google.cloud.billing_v1.types.ListSkusResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[cloud_catalog.ListSkusResponse]], - request: cloud_catalog.ListSkusRequest, - response: cloud_catalog.ListSkusResponse, - *, - 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.billing_v1.types.ListSkusRequest): - The initial request object. - response (google.cloud.billing_v1.types.ListSkusResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = cloud_catalog.ListSkusRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[cloud_catalog.ListSkusResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[cloud_catalog.Sku]: - async def async_generator(): - async for page in self.pages: - for response in page.skus: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py deleted file mode 100644 index f6dd41c9ea9a..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/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 CloudCatalogTransport -from .grpc import CloudCatalogGrpcTransport -from .grpc_asyncio import CloudCatalogGrpcAsyncIOTransport -from .rest import CloudCatalogRestTransport -from .rest import CloudCatalogRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[CloudCatalogTransport]] -_transport_registry['grpc'] = CloudCatalogGrpcTransport -_transport_registry['grpc_asyncio'] = CloudCatalogGrpcAsyncIOTransport -_transport_registry['rest'] = CloudCatalogRestTransport - -__all__ = ( - 'CloudCatalogTransport', - 'CloudCatalogGrpcTransport', - 'CloudCatalogGrpcAsyncIOTransport', - 'CloudCatalogRestTransport', - 'CloudCatalogRestInterceptor', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py deleted file mode 100644 index cbc3176979d5..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py +++ /dev/null @@ -1,164 +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.billing_v1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.billing_v1.types import cloud_catalog - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class CloudCatalogTransport(abc.ABC): - """Abstract transport class for CloudCatalog.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'cloudbilling.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.list_services: gapic_v1.method.wrap_method( - self.list_services, - default_timeout=60.0, - client_info=client_info, - ), - self.list_skus: gapic_v1.method.wrap_method( - self.list_skus, - default_timeout=60.0, - 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 list_services(self) -> Callable[ - [cloud_catalog.ListServicesRequest], - Union[ - cloud_catalog.ListServicesResponse, - Awaitable[cloud_catalog.ListServicesResponse] - ]]: - raise NotImplementedError() - - @property - def list_skus(self) -> Callable[ - [cloud_catalog.ListSkusRequest], - Union[ - cloud_catalog.ListSkusResponse, - Awaitable[cloud_catalog.ListSkusResponse] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'CloudCatalogTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py deleted file mode 100644 index 8d2e8587fae0..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py +++ /dev/null @@ -1,293 +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 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.billing_v1.types import cloud_catalog -from .base import CloudCatalogTransport, DEFAULT_CLIENT_INFO - - -class CloudCatalogGrpcTransport(CloudCatalogTransport): - """gRPC backend transport for CloudCatalog. - - A catalog of Google Cloud Platform services and SKUs. - Provides pricing information and metadata on Google Cloud - Platform services and SKUs. - - 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 = 'cloudbilling.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] = {} - - 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 = 'cloudbilling.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 list_services(self) -> Callable[ - [cloud_catalog.ListServicesRequest], - cloud_catalog.ListServicesResponse]: - r"""Return a callable for the list services method over gRPC. - - Lists all public cloud services. - - Returns: - Callable[[~.ListServicesRequest], - ~.ListServicesResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_services' not in self._stubs: - self._stubs['list_services'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudCatalog/ListServices', - request_serializer=cloud_catalog.ListServicesRequest.serialize, - response_deserializer=cloud_catalog.ListServicesResponse.deserialize, - ) - return self._stubs['list_services'] - - @property - def list_skus(self) -> Callable[ - [cloud_catalog.ListSkusRequest], - cloud_catalog.ListSkusResponse]: - r"""Return a callable for the list skus method over gRPC. - - Lists all publicly available SKUs for a given cloud - service. - - Returns: - Callable[[~.ListSkusRequest], - ~.ListSkusResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_skus' not in self._stubs: - self._stubs['list_skus'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudCatalog/ListSkus', - request_serializer=cloud_catalog.ListSkusRequest.serialize, - response_deserializer=cloud_catalog.ListSkusResponse.deserialize, - ) - return self._stubs['list_skus'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'CloudCatalogGrpcTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py deleted file mode 100644 index 82a2bd24dbd8..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py +++ /dev/null @@ -1,292 +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.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.billing_v1.types import cloud_catalog -from .base import CloudCatalogTransport, DEFAULT_CLIENT_INFO -from .grpc import CloudCatalogGrpcTransport - - -class CloudCatalogGrpcAsyncIOTransport(CloudCatalogTransport): - """gRPC AsyncIO backend transport for CloudCatalog. - - A catalog of Google Cloud Platform services and SKUs. - Provides pricing information and metadata on Google Cloud - Platform services and SKUs. - - 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 = 'cloudbilling.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 = 'cloudbilling.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] = {} - - 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 list_services(self) -> Callable[ - [cloud_catalog.ListServicesRequest], - Awaitable[cloud_catalog.ListServicesResponse]]: - r"""Return a callable for the list services method over gRPC. - - Lists all public cloud services. - - Returns: - Callable[[~.ListServicesRequest], - Awaitable[~.ListServicesResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_services' not in self._stubs: - self._stubs['list_services'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudCatalog/ListServices', - request_serializer=cloud_catalog.ListServicesRequest.serialize, - response_deserializer=cloud_catalog.ListServicesResponse.deserialize, - ) - return self._stubs['list_services'] - - @property - def list_skus(self) -> Callable[ - [cloud_catalog.ListSkusRequest], - Awaitable[cloud_catalog.ListSkusResponse]]: - r"""Return a callable for the list skus method over gRPC. - - Lists all publicly available SKUs for a given cloud - service. - - Returns: - Callable[[~.ListSkusRequest], - Awaitable[~.ListSkusResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_skus' not in self._stubs: - self._stubs['list_skus'] = self.grpc_channel.unary_unary( - '/google.cloud.billing.v1.CloudCatalog/ListSkus', - request_serializer=cloud_catalog.ListSkusRequest.serialize, - response_deserializer=cloud_catalog.ListSkusResponse.deserialize, - ) - return self._stubs['list_skus'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'CloudCatalogGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py deleted file mode 100644 index 789e0f3b94b5..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/services/cloud_catalog/transports/rest.py +++ /dev/null @@ -1,392 +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 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.billing_v1.types import cloud_catalog - -from .base import CloudCatalogTransport, 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 CloudCatalogRestInterceptor: - """Interceptor for CloudCatalog. - - 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 CloudCatalogRestTransport. - - .. code-block:: python - class MyCustomCloudCatalogInterceptor(CloudCatalogRestInterceptor): - def pre_list_services(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_services(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_skus(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_skus(self, response): - logging.log(f"Received response: {response}") - return response - - transport = CloudCatalogRestTransport(interceptor=MyCustomCloudCatalogInterceptor()) - client = CloudCatalogClient(transport=transport) - - - """ - def pre_list_services(self, request: cloud_catalog.ListServicesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_catalog.ListServicesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_services - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudCatalog server. - """ - return request, metadata - - def post_list_services(self, response: cloud_catalog.ListServicesResponse) -> cloud_catalog.ListServicesResponse: - """Post-rpc interceptor for list_services - - Override in a subclass to manipulate the response - after it is returned by the CloudCatalog server but before - it is returned to user code. - """ - return response - def pre_list_skus(self, request: cloud_catalog.ListSkusRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_catalog.ListSkusRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_skus - - Override in a subclass to manipulate the request or metadata - before they are sent to the CloudCatalog server. - """ - return request, metadata - - def post_list_skus(self, response: cloud_catalog.ListSkusResponse) -> cloud_catalog.ListSkusResponse: - """Post-rpc interceptor for list_skus - - Override in a subclass to manipulate the response - after it is returned by the CloudCatalog server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class CloudCatalogRestStub: - _session: AuthorizedSession - _host: str - _interceptor: CloudCatalogRestInterceptor - - -class CloudCatalogRestTransport(CloudCatalogTransport): - """REST backend transport for CloudCatalog. - - A catalog of Google Cloud Platform services and SKUs. - Provides pricing information and metadata on Google Cloud - Platform services and SKUs. - - 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 = 'cloudbilling.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[CloudCatalogRestInterceptor] = 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) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or CloudCatalogRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ListServices(CloudCatalogRestStub): - def __hash__(self): - return hash("ListServices") - - def __call__(self, - request: cloud_catalog.ListServicesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_catalog.ListServicesResponse: - r"""Call the list services method over HTTP. - - Args: - request (~.cloud_catalog.ListServicesRequest): - The request object. Request message for ``ListServices``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_catalog.ListServicesResponse: - Response message for ``ListServices``. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/services', - }, - ] - request, metadata = self._interceptor.pre_list_services(request, metadata) - pb_request = cloud_catalog.ListServicesRequest.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["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_catalog.ListServicesResponse() - pb_resp = cloud_catalog.ListServicesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_services(resp) - return resp - - class _ListSkus(CloudCatalogRestStub): - def __hash__(self): - return hash("ListSkus") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: cloud_catalog.ListSkusRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> cloud_catalog.ListSkusResponse: - r"""Call the list skus method over HTTP. - - Args: - request (~.cloud_catalog.ListSkusRequest): - The request object. Request message for ``ListSkus``. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.cloud_catalog.ListSkusResponse: - Response message for ``ListSkus``. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=services/*}/skus', - }, - ] - request, metadata = self._interceptor.pre_list_skus(request, metadata) - pb_request = cloud_catalog.ListSkusRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = cloud_catalog.ListSkusResponse() - pb_resp = cloud_catalog.ListSkusResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_skus(resp) - return resp - - @property - def list_services(self) -> Callable[ - [cloud_catalog.ListServicesRequest], - cloud_catalog.ListServicesResponse]: - # 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._ListServices(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_skus(self) -> Callable[ - [cloud_catalog.ListSkusRequest], - cloud_catalog.ListSkusResponse]: - # 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._ListSkus(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'CloudCatalogRestTransport', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py deleted file mode 100644 index 3da592e0c88a..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/__init__.py +++ /dev/null @@ -1,66 +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 .cloud_billing import ( - BillingAccount, - CreateBillingAccountRequest, - GetBillingAccountRequest, - GetProjectBillingInfoRequest, - ListBillingAccountsRequest, - ListBillingAccountsResponse, - ListProjectBillingInfoRequest, - ListProjectBillingInfoResponse, - ProjectBillingInfo, - UpdateBillingAccountRequest, - UpdateProjectBillingInfoRequest, -) -from .cloud_catalog import ( - AggregationInfo, - Category, - GeoTaxonomy, - ListServicesRequest, - ListServicesResponse, - ListSkusRequest, - ListSkusResponse, - PricingExpression, - PricingInfo, - Service, - Sku, -) - -__all__ = ( - 'BillingAccount', - 'CreateBillingAccountRequest', - 'GetBillingAccountRequest', - 'GetProjectBillingInfoRequest', - 'ListBillingAccountsRequest', - 'ListBillingAccountsResponse', - 'ListProjectBillingInfoRequest', - 'ListProjectBillingInfoResponse', - 'ProjectBillingInfo', - 'UpdateBillingAccountRequest', - 'UpdateProjectBillingInfoRequest', - 'AggregationInfo', - 'Category', - 'GeoTaxonomy', - 'ListServicesRequest', - 'ListServicesResponse', - 'ListSkusRequest', - 'ListSkusResponse', - 'PricingExpression', - 'PricingInfo', - 'Service', - 'Sku', -) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py deleted file mode 100644 index 6d3d851fb89c..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_billing.py +++ /dev/null @@ -1,377 +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 - - -__protobuf__ = proto.module( - package='google.cloud.billing.v1', - manifest={ - 'BillingAccount', - 'ProjectBillingInfo', - 'GetBillingAccountRequest', - 'ListBillingAccountsRequest', - 'ListBillingAccountsResponse', - 'CreateBillingAccountRequest', - 'UpdateBillingAccountRequest', - 'ListProjectBillingInfoRequest', - 'ListProjectBillingInfoResponse', - 'GetProjectBillingInfoRequest', - 'UpdateProjectBillingInfoRequest', - }, -) - - -class BillingAccount(proto.Message): - r"""A billing account in the `Google Cloud - Console `__. You can assign a - billing account to one or more projects. - - Attributes: - name (str): - Output only. The resource name of the billing account. The - resource name has the form - ``billingAccounts/{billing_account_id}``. For example, - ``billingAccounts/012345-567890-ABCDEF`` would be the - resource name for billing account ``012345-567890-ABCDEF``. - open_ (bool): - Output only. True if the billing account is - open, and will therefore be charged for any - usage on associated projects. False if the - billing account is closed, and therefore - projects associated with it will be unable to - use paid services. - display_name (str): - The display name given to the billing account, such as - ``My Billing Account``. This name is displayed in the Google - Cloud Console. - master_billing_account (str): - If this account is a - `subaccount `__, - then this will be the resource name of the parent billing - account that it is being resold through. Otherwise this will - be empty. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - open_: bool = proto.Field( - proto.BOOL, - number=2, - ) - display_name: str = proto.Field( - proto.STRING, - number=3, - ) - master_billing_account: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ProjectBillingInfo(proto.Message): - r"""Encapsulation of billing information for a Google Cloud - Console project. A project has at most one associated billing - account at a time (but a billing account can be assigned to - multiple projects). - - Attributes: - name (str): - Output only. The resource name for the - ``ProjectBillingInfo``; has the form - ``projects/{project_id}/billingInfo``. For example, the - resource name for the billing information for project - ``tokyo-rain-123`` would be - ``projects/tokyo-rain-123/billingInfo``. This field is - read-only. - project_id (str): - Output only. The ID of the project that this - ``ProjectBillingInfo`` represents, such as - ``tokyo-rain-123``. This is a convenience field so that you - don't need to parse the ``name`` field to obtain a project - ID. This field is read-only. - billing_account_name (str): - The resource name of the billing account associated with the - project, if any. For example, - ``billingAccounts/012345-567890-ABCDEF``. - billing_enabled (bool): - Output only. True if the project is - associated with an open billing account, to - which usage on the project is charged. False if - the project is associated with a closed billing - account, or no billing account at all, and - therefore cannot use paid services. This field - is read-only. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - project_id: str = proto.Field( - proto.STRING, - number=2, - ) - billing_account_name: str = proto.Field( - proto.STRING, - number=3, - ) - billing_enabled: bool = proto.Field( - proto.BOOL, - number=4, - ) - - -class GetBillingAccountRequest(proto.Message): - r"""Request message for ``GetBillingAccount``. - - Attributes: - name (str): - Required. The resource name of the billing account to - retrieve. For example, - ``billingAccounts/012345-567890-ABCDEF``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ListBillingAccountsRequest(proto.Message): - r"""Request message for ``ListBillingAccounts``. - - Attributes: - page_size (int): - Requested page size. The maximum page size is - 100; this is also the default. - page_token (str): - A token identifying a page of results to return. This should - be a ``next_page_token`` value returned from a previous - ``ListBillingAccounts`` call. If unspecified, the first page - of results is returned. - filter (str): - Options for how to filter the returned billing accounts. - Currently this only supports filtering for - `subaccounts `__ - under a single provided reseller billing account. (e.g. - "master_billing_account=billingAccounts/012345-678901-ABCDEF"). - Boolean algebra and other fields are not currently - supported. - """ - - page_size: int = proto.Field( - proto.INT32, - number=1, - ) - page_token: str = proto.Field( - proto.STRING, - number=2, - ) - filter: str = proto.Field( - proto.STRING, - number=3, - ) - - -class ListBillingAccountsResponse(proto.Message): - r"""Response message for ``ListBillingAccounts``. - - Attributes: - billing_accounts (MutableSequence[google.cloud.billing_v1.types.BillingAccount]): - A list of billing accounts. - next_page_token (str): - A token to retrieve the next page of results. To retrieve - the next page, call ``ListBillingAccounts`` again with the - ``page_token`` field set to this value. This field is empty - if there are no more results to retrieve. - """ - - @property - def raw_page(self): - return self - - billing_accounts: MutableSequence['BillingAccount'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='BillingAccount', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class CreateBillingAccountRequest(proto.Message): - r"""Request message for ``CreateBillingAccount``. - - Attributes: - billing_account (google.cloud.billing_v1.types.BillingAccount): - Required. The billing account resource to - create. Currently CreateBillingAccount only - supports subaccount creation, so any created - billing accounts must be under a provided parent - billing account. - """ - - billing_account: 'BillingAccount' = proto.Field( - proto.MESSAGE, - number=1, - message='BillingAccount', - ) - - -class UpdateBillingAccountRequest(proto.Message): - r"""Request message for ``UpdateBillingAccount``. - - Attributes: - name (str): - Required. The name of the billing account - resource to be updated. - account (google.cloud.billing_v1.types.BillingAccount): - Required. The billing account resource to - replace the resource on the server. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The update mask applied to the resource. Only "display_name" - is currently supported. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - account: 'BillingAccount' = proto.Field( - proto.MESSAGE, - number=2, - message='BillingAccount', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - - -class ListProjectBillingInfoRequest(proto.Message): - r"""Request message for ``ListProjectBillingInfo``. - - Attributes: - name (str): - Required. The resource name of the billing account - associated with the projects that you want to list. For - example, ``billingAccounts/012345-567890-ABCDEF``. - page_size (int): - Requested page size. The maximum page size is - 100; this is also the default. - page_token (str): - A token identifying a page of results to be returned. This - should be a ``next_page_token`` value returned from a - previous ``ListProjectBillingInfo`` call. If unspecified, - the first page of results is returned. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - - -class ListProjectBillingInfoResponse(proto.Message): - r"""Request message for ``ListProjectBillingInfoResponse``. - - Attributes: - project_billing_info (MutableSequence[google.cloud.billing_v1.types.ProjectBillingInfo]): - A list of ``ProjectBillingInfo`` resources representing the - projects associated with the billing account. - next_page_token (str): - A token to retrieve the next page of results. To retrieve - the next page, call ``ListProjectBillingInfo`` again with - the ``page_token`` field set to this value. This field is - empty if there are no more results to retrieve. - """ - - @property - def raw_page(self): - return self - - project_billing_info: MutableSequence['ProjectBillingInfo'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='ProjectBillingInfo', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetProjectBillingInfoRequest(proto.Message): - r"""Request message for ``GetProjectBillingInfo``. - - Attributes: - name (str): - Required. The resource name of the project for which billing - information is retrieved. For example, - ``projects/tokyo-rain-123``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateProjectBillingInfoRequest(proto.Message): - r"""Request message for ``UpdateProjectBillingInfo``. - - Attributes: - name (str): - Required. The resource name of the project associated with - the billing information that you want to update. For - example, ``projects/tokyo-rain-123``. - project_billing_info (google.cloud.billing_v1.types.ProjectBillingInfo): - The new billing information for the project. Read-only - fields are ignored; thus, you can leave empty all fields - except ``billing_account_name``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - project_billing_info: 'ProjectBillingInfo' = proto.Field( - proto.MESSAGE, - number=2, - message='ProjectBillingInfo', - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py b/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py deleted file mode 100644 index 813a6520a5fd..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/google/cloud/billing_v1/types/cloud_catalog.py +++ /dev/null @@ -1,602 +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 timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.billing.v1', - manifest={ - 'Service', - 'Sku', - 'Category', - 'PricingInfo', - 'PricingExpression', - 'AggregationInfo', - 'GeoTaxonomy', - 'ListServicesRequest', - 'ListServicesResponse', - 'ListSkusRequest', - 'ListSkusResponse', - }, -) - - -class Service(proto.Message): - r"""Encapsulates a single service in Google Cloud Platform. - - Attributes: - name (str): - The resource name for the service. - Example: "services/DA34-426B-A397". - service_id (str): - The identifier for the service. - Example: "DA34-426B-A397". - display_name (str): - A human readable display name for this - service. - business_entity_name (str): - The business under which the service is - offered. Ex. "businessEntities/GCP", - "businessEntities/Maps". - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - service_id: str = proto.Field( - proto.STRING, - number=2, - ) - display_name: str = proto.Field( - proto.STRING, - number=3, - ) - business_entity_name: str = proto.Field( - proto.STRING, - number=4, - ) - - -class Sku(proto.Message): - r"""Encapsulates a single SKU in Google Cloud Platform - - Attributes: - name (str): - The resource name for the SKU. - Example: - "services/DA34-426B-A397/skus/AA95-CD31-42FE". - sku_id (str): - The identifier for the SKU. - Example: "AA95-CD31-42FE". - description (str): - A human readable description of the SKU, has - a maximum length of 256 characters. - category (google.cloud.billing_v1.types.Category): - The category hierarchy of this SKU, purely - for organizational purpose. - service_regions (MutableSequence[str]): - List of service regions this SKU is offered - at. Example: "asia-east1" - Service regions can be found at - https://cloud.google.com/about/locations/ - pricing_info (MutableSequence[google.cloud.billing_v1.types.PricingInfo]): - A timeline of pricing info for this SKU in - chronological order. - service_provider_name (str): - Identifies the service provider. - This is 'Google' for first party services in - Google Cloud Platform. - geo_taxonomy (google.cloud.billing_v1.types.GeoTaxonomy): - The geographic taxonomy for this sku. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - sku_id: str = proto.Field( - proto.STRING, - number=2, - ) - description: str = proto.Field( - proto.STRING, - number=3, - ) - category: 'Category' = proto.Field( - proto.MESSAGE, - number=4, - message='Category', - ) - service_regions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=5, - ) - pricing_info: MutableSequence['PricingInfo'] = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='PricingInfo', - ) - service_provider_name: str = proto.Field( - proto.STRING, - number=7, - ) - geo_taxonomy: 'GeoTaxonomy' = proto.Field( - proto.MESSAGE, - number=8, - message='GeoTaxonomy', - ) - - -class Category(proto.Message): - r"""Represents the category hierarchy of a SKU. - - Attributes: - service_display_name (str): - The display name of the service this SKU - belongs to. - resource_family (str): - The type of product the SKU refers to. - Example: "Compute", "Storage", "Network", - "ApplicationServices" etc. - resource_group (str): - A group classification for related SKUs. - Example: "RAM", "GPU", "Prediction", "Ops", - "GoogleEgress" etc. - usage_type (str): - Represents how the SKU is consumed. - Example: "OnDemand", "Preemptible", "Commit1Mo", - "Commit1Yr" etc. - """ - - service_display_name: str = proto.Field( - proto.STRING, - number=1, - ) - resource_family: str = proto.Field( - proto.STRING, - number=2, - ) - resource_group: str = proto.Field( - proto.STRING, - number=3, - ) - usage_type: str = proto.Field( - proto.STRING, - number=4, - ) - - -class PricingInfo(proto.Message): - r"""Represents the pricing information for a SKU at a single - point of time. - - Attributes: - effective_time (google.protobuf.timestamp_pb2.Timestamp): - The timestamp from which this pricing was effective within - the requested time range. This is guaranteed to be greater - than or equal to the start_time field in the request and - less than the end_time field in the request. If a time range - was not specified in the request this field will be - equivalent to a time within the last 12 hours, indicating - the latest pricing info. - summary (str): - An optional human readable summary of the - pricing information, has a maximum length of 256 - characters. - pricing_expression (google.cloud.billing_v1.types.PricingExpression): - Expresses the pricing formula. See ``PricingExpression`` for - an example. - aggregation_info (google.cloud.billing_v1.types.AggregationInfo): - Aggregation Info. This can be left - unspecified if the pricing expression doesn't - require aggregation. - currency_conversion_rate (float): - Conversion rate used for currency conversion, from USD to - the currency specified in the request. This includes any - surcharge collected for billing in non USD currency. If a - currency is not specified in the request this defaults to - 1.0. Example: USD \* currency_conversion_rate = JPY - """ - - effective_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - summary: str = proto.Field( - proto.STRING, - number=2, - ) - pricing_expression: 'PricingExpression' = proto.Field( - proto.MESSAGE, - number=3, - message='PricingExpression', - ) - aggregation_info: 'AggregationInfo' = proto.Field( - proto.MESSAGE, - number=4, - message='AggregationInfo', - ) - currency_conversion_rate: float = proto.Field( - proto.DOUBLE, - number=5, - ) - - -class PricingExpression(proto.Message): - r"""Expresses a mathematical pricing formula. For Example:- - - ``usage_unit: GBy`` ``tiered_rates:`` - ``[start_usage_amount: 20, unit_price: $10]`` - ``[start_usage_amount: 100, unit_price: $5]`` - - The above expresses a pricing formula where the first 20GB is free, - the next 80GB is priced at $10 per GB followed by $5 per GB for - additional usage. - - Attributes: - usage_unit (str): - The short hand for unit of usage this pricing is specified - in. Example: usage_unit of "GiBy" means that usage is - specified in "Gibi Byte". - display_quantity (float): - The recommended quantity of units for displaying pricing - info. When displaying pricing info it is recommended to - display: (unit_price \* display_quantity) per - display_quantity usage_unit. This field does not affect the - pricing formula and is for display purposes only. Example: - If the unit_price is "0.0001 USD", the usage_unit is "GB" - and the display_quantity is "1000" then the recommended way - of displaying the pricing info is "0.10 USD per 1000 GB". - tiered_rates (MutableSequence[google.cloud.billing_v1.types.PricingExpression.TierRate]): - The list of tiered rates for this pricing. The total cost is - computed by applying each of the tiered rates on usage. This - repeated list is sorted by ascending order of - start_usage_amount. - usage_unit_description (str): - The unit of usage in human readable form. - Example: "gibi byte". - base_unit (str): - The base unit for the SKU which is the unit - used in usage exports. Example: "By". - base_unit_description (str): - The base unit in human readable form. - Example: "byte". - base_unit_conversion_factor (float): - Conversion factor for converting from price per usage_unit - to price per base_unit, and start_usage_amount to - start_usage_amount in base_unit. unit_price / - base_unit_conversion_factor = price per base_unit. - start_usage_amount \* base_unit_conversion_factor = - start_usage_amount in base_unit. - """ - - class TierRate(proto.Message): - r"""The price rate indicating starting usage and its - corresponding price. - - Attributes: - start_usage_amount (float): - Usage is priced at this rate only after this amount. - Example: start_usage_amount of 10 indicates that the usage - will be priced at the unit_price after the first 10 - usage_units. - unit_price (google.type.money_pb2.Money): - The price per unit of usage. Example: unit_price of amount - $10 indicates that each unit will cost $10. - """ - - start_usage_amount: float = proto.Field( - proto.DOUBLE, - number=1, - ) - unit_price: money_pb2.Money = proto.Field( - proto.MESSAGE, - number=2, - message=money_pb2.Money, - ) - - usage_unit: str = proto.Field( - proto.STRING, - number=1, - ) - display_quantity: float = proto.Field( - proto.DOUBLE, - number=2, - ) - tiered_rates: MutableSequence[TierRate] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message=TierRate, - ) - usage_unit_description: str = proto.Field( - proto.STRING, - number=4, - ) - base_unit: str = proto.Field( - proto.STRING, - number=5, - ) - base_unit_description: str = proto.Field( - proto.STRING, - number=6, - ) - base_unit_conversion_factor: float = proto.Field( - proto.DOUBLE, - number=7, - ) - - -class AggregationInfo(proto.Message): - r"""Represents the aggregation level and interval for pricing of - a single SKU. - - Attributes: - aggregation_level (google.cloud.billing_v1.types.AggregationInfo.AggregationLevel): - - aggregation_interval (google.cloud.billing_v1.types.AggregationInfo.AggregationInterval): - - aggregation_count (int): - The number of intervals to aggregate over. Example: If - aggregation_level is "DAILY" and aggregation_count is 14, - aggregation will be over 14 days. - """ - class AggregationLevel(proto.Enum): - r"""The level at which usage is aggregated to compute cost. - Example: "ACCOUNT" aggregation level indicates that usage for - tiered pricing is aggregated across all projects in a single - account. - - Values: - AGGREGATION_LEVEL_UNSPECIFIED (0): - No description available. - ACCOUNT (1): - No description available. - PROJECT (2): - No description available. - """ - AGGREGATION_LEVEL_UNSPECIFIED = 0 - ACCOUNT = 1 - PROJECT = 2 - - class AggregationInterval(proto.Enum): - r"""The interval at which usage is aggregated to compute cost. - Example: "MONTHLY" aggregation interval indicates that usage for - tiered pricing is aggregated every month. - - Values: - AGGREGATION_INTERVAL_UNSPECIFIED (0): - No description available. - DAILY (1): - No description available. - MONTHLY (2): - No description available. - """ - AGGREGATION_INTERVAL_UNSPECIFIED = 0 - DAILY = 1 - MONTHLY = 2 - - aggregation_level: AggregationLevel = proto.Field( - proto.ENUM, - number=1, - enum=AggregationLevel, - ) - aggregation_interval: AggregationInterval = proto.Field( - proto.ENUM, - number=2, - enum=AggregationInterval, - ) - aggregation_count: int = proto.Field( - proto.INT32, - number=3, - ) - - -class GeoTaxonomy(proto.Message): - r"""Encapsulates the geographic taxonomy data for a sku. - - Attributes: - type_ (google.cloud.billing_v1.types.GeoTaxonomy.Type): - The type of Geo Taxonomy: GLOBAL, REGIONAL, or - MULTI_REGIONAL. - regions (MutableSequence[str]): - The list of regions associated with a sku. - Empty for Global skus, which are associated with - all Google Cloud regions. - """ - class Type(proto.Enum): - r"""The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL. - - Values: - TYPE_UNSPECIFIED (0): - The type is not specified. - GLOBAL (1): - The sku is global in nature, e.g. a license - sku. Global skus are available in all regions, - and so have an empty region list. - REGIONAL (2): - The sku is available in a specific region, - e.g. "us-west2". - MULTI_REGIONAL (3): - The sku is associated with multiple regions, - e.g. "us-west2" and "us-east1". - """ - TYPE_UNSPECIFIED = 0 - GLOBAL = 1 - REGIONAL = 2 - MULTI_REGIONAL = 3 - - type_: Type = proto.Field( - proto.ENUM, - number=1, - enum=Type, - ) - regions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=2, - ) - - -class ListServicesRequest(proto.Message): - r"""Request message for ``ListServices``. - - Attributes: - page_size (int): - Requested page size. Defaults to 5000. - page_token (str): - A token identifying a page of results to return. This should - be a ``next_page_token`` value returned from a previous - ``ListServices`` call. If unspecified, the first page of - results is returned. - """ - - page_size: int = proto.Field( - proto.INT32, - number=1, - ) - page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class ListServicesResponse(proto.Message): - r"""Response message for ``ListServices``. - - Attributes: - services (MutableSequence[google.cloud.billing_v1.types.Service]): - A list of services. - next_page_token (str): - A token to retrieve the next page of results. To retrieve - the next page, call ``ListServices`` again with the - ``page_token`` field set to this value. This field is empty - if there are no more results to retrieve. - """ - - @property - def raw_page(self): - return self - - services: MutableSequence['Service'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Service', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class ListSkusRequest(proto.Message): - r"""Request message for ``ListSkus``. - - Attributes: - parent (str): - Required. The name of the service. - Example: "services/DA34-426B-A397". - start_time (google.protobuf.timestamp_pb2.Timestamp): - Optional inclusive start time of the time range for which - the pricing versions will be returned. Timestamps in the - future are not allowed. The time range has to be within a - single calendar month in America/Los_Angeles timezone. Time - range as a whole is optional. If not specified, the latest - pricing will be returned (up to 12 hours old at most). - end_time (google.protobuf.timestamp_pb2.Timestamp): - Optional exclusive end time of the time range for which the - pricing versions will be returned. Timestamps in the future - are not allowed. The time range has to be within a single - calendar month in America/Los_Angeles timezone. Time range - as a whole is optional. If not specified, the latest pricing - will be returned (up to 12 hours old at most). - currency_code (str): - The ISO 4217 currency code for the pricing info in the - response proto. Will use the conversion rate as of - start_time. Optional. If not specified USD will be used. - page_size (int): - Requested page size. Defaults to 5000. - page_token (str): - A token identifying a page of results to return. This should - be a ``next_page_token`` value returned from a previous - ``ListSkus`` call. If unspecified, the first page of results - is returned. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - start_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - currency_code: str = proto.Field( - proto.STRING, - number=4, - ) - page_size: int = proto.Field( - proto.INT32, - number=5, - ) - page_token: str = proto.Field( - proto.STRING, - number=6, - ) - - -class ListSkusResponse(proto.Message): - r"""Response message for ``ListSkus``. - - Attributes: - skus (MutableSequence[google.cloud.billing_v1.types.Sku]): - The list of public SKUs of the given service. - next_page_token (str): - A token to retrieve the next page of results. To retrieve - the next page, call ``ListSkus`` again with the - ``page_token`` field set to this value. This field is empty - if there are no more results to retrieve. - """ - - @property - def raw_page(self): - return self - - skus: MutableSequence['Sku'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Sku', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-billing/v1/mypy.ini b/owl-bot-staging/google-cloud-billing/v1/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-cloud-billing/v1/noxfile.py b/owl-bot-staging/google-cloud-billing/v1/noxfile.py deleted file mode 100644 index 45e34dabb7c9..000000000000 --- a/owl-bot-staging/google-cloud-billing/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/billing_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/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py b/owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py deleted file mode 100644 index 557ca9729200..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/scripts/fixup_billing_v1_keywords.py +++ /dev/null @@ -1,187 +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 billingCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_billing_account': ('billing_account', ), - 'get_billing_account': ('name', ), - 'get_iam_policy': ('resource', 'options', ), - 'get_project_billing_info': ('name', ), - 'list_billing_accounts': ('page_size', 'page_token', 'filter', ), - 'list_project_billing_info': ('name', 'page_size', 'page_token', ), - 'list_services': ('page_size', 'page_token', ), - 'list_skus': ('parent', 'start_time', 'end_time', 'currency_code', 'page_size', 'page_token', ), - 'set_iam_policy': ('resource', 'policy', 'update_mask', ), - 'test_iam_permissions': ('resource', 'permissions', ), - 'update_billing_account': ('name', 'account', 'update_mask', ), - 'update_project_billing_info': ('name', 'project_billing_info', ), - } - - 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=billingCallTransformer(), -): - """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 billing client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-cloud-billing/v1/setup.py b/owl-bot-staging/google-cloud-billing/v1/setup.py deleted file mode 100644 index eec7275f8a68..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/setup.py +++ /dev/null @@ -1,91 +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-billing' - - -description = "Google Cloud Billing API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/billing/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", - "grpc-google-iam-v1 >= 0.12.4, <1.0.0dev", -] -url = "https://github.com/googleapis/python-billing" - -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/google-cloud-billing/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt deleted file mode 100644 index 2beecf99e0be..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,10 +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 -grpc-google-iam-v1==0.12.4 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-billing/v1/tests/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/__init__.py deleted file mode 100644 index 231bc125017b..000000000000 --- a/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/__init__.py deleted file mode 100644 index 231bc125017b..000000000000 --- a/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 231bc125017b..000000000000 --- a/owl-bot-staging/google-cloud-billing/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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/__init__.py deleted file mode 100644 index 231bc125017b..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py deleted file mode 100644 index ba1478da6cb2..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py +++ /dev/null @@ -1,6262 +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 gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.billing_v1.services.cloud_billing import CloudBillingAsyncClient -from google.cloud.billing_v1.services.cloud_billing import CloudBillingClient -from google.cloud.billing_v1.services.cloud_billing import pagers -from google.cloud.billing_v1.services.cloud_billing import transports -from google.cloud.billing_v1.types import cloud_billing -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import options_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import field_mask_pb2 # type: ignore -from google.type import expr_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 CloudBillingClient._get_default_mtls_endpoint(None) is None - assert CloudBillingClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert CloudBillingClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert CloudBillingClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert CloudBillingClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert CloudBillingClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (CloudBillingClient, "grpc"), - (CloudBillingAsyncClient, "grpc_asyncio"), - (CloudBillingClient, "rest"), -]) -def test_cloud_billing_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 == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://cloudbilling.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.CloudBillingGrpcTransport, "grpc"), - (transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.CloudBillingRestTransport, "rest"), -]) -def test_cloud_billing_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", [ - (CloudBillingClient, "grpc"), - (CloudBillingAsyncClient, "grpc_asyncio"), - (CloudBillingClient, "rest"), -]) -def test_cloud_billing_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 == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://cloudbilling.googleapis.com' - ) - - -def test_cloud_billing_client_get_transport_class(): - transport = CloudBillingClient.get_transport_class() - available_transports = [ - transports.CloudBillingGrpcTransport, - transports.CloudBillingRestTransport, - ] - assert transport in available_transports - - transport = CloudBillingClient.get_transport_class("grpc") - assert transport == transports.CloudBillingGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), - (CloudBillingClient, transports.CloudBillingRestTransport, "rest"), -]) -@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) -@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) -def test_cloud_billing_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(CloudBillingClient, '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(CloudBillingClient, '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", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", "true"), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", "false"), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (CloudBillingClient, transports.CloudBillingRestTransport, "rest", "true"), - (CloudBillingClient, transports.CloudBillingRestTransport, "rest", "false"), -]) -@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) -@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_cloud_billing_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", [ - CloudBillingClient, CloudBillingAsyncClient -]) -@mock.patch.object(CloudBillingClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingClient)) -@mock.patch.object(CloudBillingAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudBillingAsyncClient)) -def test_cloud_billing_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", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), - (CloudBillingClient, transports.CloudBillingRestTransport, "rest"), -]) -def test_cloud_billing_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", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", grpc_helpers), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (CloudBillingClient, transports.CloudBillingRestTransport, "rest", None), -]) -def test_cloud_billing_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_cloud_billing_client_client_options_from_dict(): - with mock.patch('google.cloud.billing_v1.services.cloud_billing.transports.CloudBillingGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = CloudBillingClient( - 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", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc", grpc_helpers), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_cloud_billing_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( - "cloudbilling.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="cloudbilling.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.GetBillingAccountRequest, - dict, -]) -def test_get_billing_account(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - response = client.get_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_get_billing_account_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 = CloudBillingClient( - 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_billing_account), - '__call__') as call: - client.get_billing_account() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetBillingAccountRequest() - -@pytest.mark.asyncio -async def test_get_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.GetBillingAccountRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - )) - response = await client.get_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -@pytest.mark.asyncio -async def test_get_billing_account_async_from_dict(): - await test_get_billing_account_async(request_type=dict) - - -def test_get_billing_account_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.GetBillingAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_billing_account), - '__call__') as call: - call.return_value = cloud_billing.BillingAccount() - client.get_billing_account(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_billing_account_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.GetBillingAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_billing_account), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) - await client.get_billing_account(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_billing_account_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_billing_account( - 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_billing_account_flattened_error(): - client = CloudBillingClient( - 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_billing_account( - cloud_billing.GetBillingAccountRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_billing_account_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_billing_account( - 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_billing_account_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_billing_account( - cloud_billing.GetBillingAccountRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.ListBillingAccountsRequest, - dict, -]) -def test_list_billing_accounts(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_accounts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ListBillingAccountsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_billing_accounts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListBillingAccountsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListBillingAccountsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_billing_accounts_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 = CloudBillingClient( - 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_billing_accounts), - '__call__') as call: - client.list_billing_accounts() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListBillingAccountsRequest() - -@pytest.mark.asyncio -async def test_list_billing_accounts_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.ListBillingAccountsRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_accounts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListBillingAccountsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_billing_accounts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListBillingAccountsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListBillingAccountsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_billing_accounts_async_from_dict(): - await test_list_billing_accounts_async(request_type=dict) - - -def test_list_billing_accounts_pager(transport_name: str = "grpc"): - client = CloudBillingClient( - 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_billing_accounts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - next_page_token='abc', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[], - next_page_token='def', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - ], - next_page_token='ghi', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - ), - RuntimeError, - ) - - metadata = () - pager = client.list_billing_accounts(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_billing.BillingAccount) - for i in results) -def test_list_billing_accounts_pages(transport_name: str = "grpc"): - client = CloudBillingClient( - 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_billing_accounts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - next_page_token='abc', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[], - next_page_token='def', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - ], - next_page_token='ghi', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - ), - RuntimeError, - ) - pages = list(client.list_billing_accounts(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_billing_accounts_async_pager(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_billing_accounts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - next_page_token='abc', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[], - next_page_token='def', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - ], - next_page_token='ghi', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_billing_accounts(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, cloud_billing.BillingAccount) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_billing_accounts_async_pages(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_billing_accounts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - next_page_token='abc', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[], - next_page_token='def', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - ], - next_page_token='ghi', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_billing_accounts(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - cloud_billing.UpdateBillingAccountRequest, - dict, -]) -def test_update_billing_account(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - response = client.update_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_update_billing_account_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 = CloudBillingClient( - 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_billing_account), - '__call__') as call: - client.update_billing_account() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateBillingAccountRequest() - -@pytest.mark.asyncio -async def test_update_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.UpdateBillingAccountRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - )) - response = await client.update_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -@pytest.mark.asyncio -async def test_update_billing_account_async_from_dict(): - await test_update_billing_account_async(request_type=dict) - - -def test_update_billing_account_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.UpdateBillingAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_billing_account), - '__call__') as call: - call.return_value = cloud_billing.BillingAccount() - client.update_billing_account(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_update_billing_account_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.UpdateBillingAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_billing_account), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) - await client.update_billing_account(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_update_billing_account_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_billing_account( - name='name_value', - account=cloud_billing.BillingAccount(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 - arg = args[0].account - mock_val = cloud_billing.BillingAccount(name='name_value') - assert arg == mock_val - - -def test_update_billing_account_flattened_error(): - client = CloudBillingClient( - 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_billing_account( - cloud_billing.UpdateBillingAccountRequest(), - name='name_value', - account=cloud_billing.BillingAccount(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_update_billing_account_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_billing_account( - name='name_value', - account=cloud_billing.BillingAccount(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 - arg = args[0].account - mock_val = cloud_billing.BillingAccount(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_update_billing_account_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_billing_account( - cloud_billing.UpdateBillingAccountRequest(), - name='name_value', - account=cloud_billing.BillingAccount(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.CreateBillingAccountRequest, - dict, -]) -def test_create_billing_account(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - response = client.create_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.CreateBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_create_billing_account_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 = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_billing_account), - '__call__') as call: - client.create_billing_account() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.CreateBillingAccountRequest() - -@pytest.mark.asyncio -async def test_create_billing_account_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.CreateBillingAccountRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - )) - response = await client.create_billing_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.CreateBillingAccountRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -@pytest.mark.asyncio -async def test_create_billing_account_async_from_dict(): - await test_create_billing_account_async(request_type=dict) - - -def test_create_billing_account_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_billing_account( - billing_account=cloud_billing.BillingAccount(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].billing_account - mock_val = cloud_billing.BillingAccount(name='name_value') - assert arg == mock_val - - -def test_create_billing_account_flattened_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_billing_account( - cloud_billing.CreateBillingAccountRequest(), - billing_account=cloud_billing.BillingAccount(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_billing_account_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_billing_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.BillingAccount() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.BillingAccount()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_billing_account( - billing_account=cloud_billing.BillingAccount(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].billing_account - mock_val = cloud_billing.BillingAccount(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_billing_account_flattened_error_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_billing_account( - cloud_billing.CreateBillingAccountRequest(), - billing_account=cloud_billing.BillingAccount(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.ListProjectBillingInfoRequest, - dict, -]) -def test_list_project_billing_info(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ListProjectBillingInfoResponse( - next_page_token='next_page_token_value', - ) - response = client.list_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListProjectBillingInfoPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_project_billing_info_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 = CloudBillingClient( - 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_project_billing_info), - '__call__') as call: - client.list_project_billing_info() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListProjectBillingInfoRequest() - -@pytest.mark.asyncio -async def test_list_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.ListProjectBillingInfoRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.ListProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListProjectBillingInfoAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_project_billing_info_async_from_dict(): - await test_list_project_billing_info_async(request_type=dict) - - -def test_list_project_billing_info_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.ListProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__') as call: - call.return_value = cloud_billing.ListProjectBillingInfoResponse() - client.list_project_billing_info(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_list_project_billing_info_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.ListProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse()) - await client.list_project_billing_info(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_list_project_billing_info_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ListProjectBillingInfoResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_project_billing_info( - 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_list_project_billing_info_flattened_error(): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.ListProjectBillingInfoRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_list_project_billing_info_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ListProjectBillingInfoResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ListProjectBillingInfoResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_project_billing_info( - 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_list_project_billing_info_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_project_billing_info( - cloud_billing.ListProjectBillingInfoRequest(), - name='name_value', - ) - - -def test_list_project_billing_info_pager(transport_name: str = "grpc"): - client = CloudBillingClient( - 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_project_billing_info), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='abc', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[], - next_page_token='def', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='ghi', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', ''), - )), - ) - pager = client.list_project_billing_info(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_billing.ProjectBillingInfo) - for i in results) -def test_list_project_billing_info_pages(transport_name: str = "grpc"): - client = CloudBillingClient( - 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_project_billing_info), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='abc', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[], - next_page_token='def', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='ghi', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - ), - RuntimeError, - ) - pages = list(client.list_project_billing_info(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_project_billing_info_async_pager(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='abc', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[], - next_page_token='def', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='ghi', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_project_billing_info(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, cloud_billing.ProjectBillingInfo) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_project_billing_info_async_pages(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_project_billing_info), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='abc', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[], - next_page_token='def', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='ghi', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_project_billing_info(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - cloud_billing.GetProjectBillingInfoRequest, - dict, -]) -def test_get_project_billing_info(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - ) - response = client.get_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -def test_get_project_billing_info_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 = CloudBillingClient( - 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_project_billing_info), - '__call__') as call: - client.get_project_billing_info() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetProjectBillingInfoRequest() - -@pytest.mark.asyncio -async def test_get_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.GetProjectBillingInfoRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - )) - response = await client.get_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.GetProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -@pytest.mark.asyncio -async def test_get_project_billing_info_async_from_dict(): - await test_get_project_billing_info_async(request_type=dict) - - -def test_get_project_billing_info_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.GetProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_project_billing_info), - '__call__') as call: - call.return_value = cloud_billing.ProjectBillingInfo() - client.get_project_billing_info(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_project_billing_info_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.GetProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_project_billing_info), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) - await client.get_project_billing_info(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_project_billing_info_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_project_billing_info( - 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_project_billing_info_flattened_error(): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.GetProjectBillingInfoRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_project_billing_info_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_project_billing_info( - 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_project_billing_info_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_project_billing_info( - cloud_billing.GetProjectBillingInfoRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.UpdateProjectBillingInfoRequest, - dict, -]) -def test_update_project_billing_info(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - ) - response = client.update_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -def test_update_project_billing_info_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 = CloudBillingClient( - 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_project_billing_info), - '__call__') as call: - client.update_project_billing_info() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() - -@pytest.mark.asyncio -async def test_update_project_billing_info_async(transport: str = 'grpc_asyncio', request_type=cloud_billing.UpdateProjectBillingInfoRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - )) - response = await client.update_project_billing_info(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_billing.UpdateProjectBillingInfoRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -@pytest.mark.asyncio -async def test_update_project_billing_info_async_from_dict(): - await test_update_project_billing_info_async(request_type=dict) - - -def test_update_project_billing_info_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.UpdateProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_project_billing_info), - '__call__') as call: - call.return_value = cloud_billing.ProjectBillingInfo() - client.update_project_billing_info(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_update_project_billing_info_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_billing.UpdateProjectBillingInfoRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_project_billing_info), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) - await client.update_project_billing_info(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_update_project_billing_info_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_project_billing_info( - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(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 - arg = args[0].project_billing_info - mock_val = cloud_billing.ProjectBillingInfo(name='name_value') - assert arg == mock_val - - -def test_update_project_billing_info_flattened_error(): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.UpdateProjectBillingInfoRequest(), - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_update_project_billing_info_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_project_billing_info), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_billing.ProjectBillingInfo() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_billing.ProjectBillingInfo()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_project_billing_info( - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(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 - arg = args[0].project_billing_info - mock_val = cloud_billing.ProjectBillingInfo(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_update_project_billing_info_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_project_billing_info( - cloud_billing.UpdateProjectBillingInfoRequest(), - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.GetIamPolicyRequest, - dict, -]) -def test_get_iam_policy(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_get_iam_policy_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 = CloudBillingClient( - 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_iam_policy), - '__call__') as call: - client.get_iam_policy() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - -@pytest.mark.asyncio -async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_get_iam_policy_async_from_dict(): - await test_get_iam_policy_async(request_type=dict) - - -def test_get_iam_policy_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_iam_policy_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - -def test_get_iam_policy_from_dict_foreign(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.get_iam_policy(request={ - 'resource': 'resource_value', - 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), - } - ) - call.assert_called() - - -def test_get_iam_policy_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_iam_policy( - resource='resource_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - - -def test_get_iam_policy_flattened_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - -@pytest.mark.asyncio -async def test_get_iam_policy_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_iam_policy( - resource='resource_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_iam_policy_flattened_error_async(): - client = CloudBillingAsyncClient( - 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_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.SetIamPolicyRequest, - dict, -]) -def test_set_iam_policy(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_set_iam_policy_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 = CloudBillingClient( - 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.set_iam_policy), - '__call__') as call: - client.set_iam_policy() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - -@pytest.mark.asyncio -async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_set_iam_policy_async_from_dict(): - await test_set_iam_policy_async(request_type=dict) - - -def test_set_iam_policy_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_iam_policy_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - -def test_set_iam_policy_from_dict_foreign(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.set_iam_policy(request={ - 'resource': 'resource_value', - 'policy': policy_pb2.Policy(version=774), - 'update_mask': field_mask_pb2.FieldMask(paths=['paths_value']), - } - ) - call.assert_called() - - -def test_set_iam_policy_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.set_iam_policy( - resource='resource_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - - -def test_set_iam_policy_flattened_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - -@pytest.mark.asyncio -async def test_set_iam_policy_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.set_iam_policy( - resource='resource_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_set_iam_policy_flattened_error_async(): - client = CloudBillingAsyncClient( - 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.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.TestIamPermissionsRequest, - dict, -]) -def test_test_iam_permissions(request_type, transport: str = 'grpc'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - ) - response = client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -def test_test_iam_permissions_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 = CloudBillingClient( - 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.test_iam_permissions), - '__call__') as call: - client.test_iam_permissions() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - -@pytest.mark.asyncio -async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - )) - response = await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_async_from_dict(): - await test_test_iam_permissions_async(request_type=dict) - - -def test_test_iam_permissions_field_headers(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_field_headers_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) - await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - -def test_test_iam_permissions_from_dict_foreign(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - response = client.test_iam_permissions(request={ - 'resource': 'resource_value', - 'permissions': ['permissions_value'], - } - ) - call.assert_called() - - -def test_test_iam_permissions_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.test_iam_permissions( - resource='resource_value', - permissions=['permissions_value'], - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - arg = args[0].permissions - mock_val = ['permissions_value'] - assert arg == mock_val - - -def test_test_iam_permissions_flattened_error(): - client = CloudBillingClient( - 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.test_iam_permissions( - iam_policy_pb2.TestIamPermissionsRequest(), - resource='resource_value', - permissions=['permissions_value'], - ) - -@pytest.mark.asyncio -async def test_test_iam_permissions_flattened_async(): - client = CloudBillingAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.test_iam_permissions( - resource='resource_value', - permissions=['permissions_value'], - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].resource - mock_val = 'resource_value' - assert arg == mock_val - arg = args[0].permissions - mock_val = ['permissions_value'] - assert arg == mock_val - -@pytest.mark.asyncio -async def test_test_iam_permissions_flattened_error_async(): - client = CloudBillingAsyncClient( - 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.test_iam_permissions( - iam_policy_pb2.TestIamPermissionsRequest(), - resource='resource_value', - permissions=['permissions_value'], - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.GetBillingAccountRequest, - dict, -]) -def test_get_billing_account_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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_billing_account(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_get_billing_account_rest_required_fields(request_type=cloud_billing.GetBillingAccountRequest): - transport_class = transports.CloudBillingRestTransport - - 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_billing_account._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_billing_account._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 = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_billing.BillingAccount.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_billing_account(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_billing_account_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_billing_account._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_billing_account_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_billing_account") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_billing_account") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.GetBillingAccountRequest.pb(cloud_billing.GetBillingAccountRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) - - request = cloud_billing.GetBillingAccountRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.BillingAccount() - - client.get_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.GetBillingAccountRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - 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_billing_account(request) - - -def test_get_billing_account_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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_billing_account(**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=billingAccounts/*}" % client.transport._host, args[1]) - - -def test_get_billing_account_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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_billing_account( - cloud_billing.GetBillingAccountRequest(), - name='name_value', - ) - - -def test_get_billing_account_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.ListBillingAccountsRequest, - dict, -]) -def test_list_billing_accounts_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ListBillingAccountsResponse( - 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 = cloud_billing.ListBillingAccountsResponse.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_billing_accounts(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListBillingAccountsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_billing_accounts_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_list_billing_accounts") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_list_billing_accounts") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.ListBillingAccountsRequest.pb(cloud_billing.ListBillingAccountsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.ListBillingAccountsResponse.to_json(cloud_billing.ListBillingAccountsResponse()) - - request = cloud_billing.ListBillingAccountsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.ListBillingAccountsResponse() - - client.list_billing_accounts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_billing_accounts_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.ListBillingAccountsRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - 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_billing_accounts(request) - - -def test_list_billing_accounts_rest_pager(transport: str = 'rest'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - next_page_token='abc', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[], - next_page_token='def', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - ], - next_page_token='ghi', - ), - cloud_billing.ListBillingAccountsResponse( - billing_accounts=[ - cloud_billing.BillingAccount(), - cloud_billing.BillingAccount(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(cloud_billing.ListBillingAccountsResponse.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 = {} - - pager = client.list_billing_accounts(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_billing.BillingAccount) - for i in results) - - pages = list(client.list_billing_accounts(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.UpdateBillingAccountRequest, - dict, -]) -def test_update_billing_account_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - request_init["account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_update_billing_account_rest_required_fields(request_type=cloud_billing.UpdateBillingAccountRequest): - transport_class = transports.CloudBillingRestTransport - - 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()).update_billing_account._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()).update_billing_account._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 - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - # 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 - - pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_billing_account_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_billing_account._get_unset_required_fields({}) - assert set(unset_fields) == (set(("updateMask", )) & set(("name", "account", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_billing_account_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_update_billing_account") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_update_billing_account") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.UpdateBillingAccountRequest.pb(cloud_billing.UpdateBillingAccountRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) - - request = cloud_billing.UpdateBillingAccountRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.BillingAccount() - - client.update_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.UpdateBillingAccountRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - request_init["account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_billing_account(request) - - -def test_update_billing_account_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - account=cloud_billing.BillingAccount(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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.update_billing_account(**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=billingAccounts/*}" % client.transport._host, args[1]) - - -def test_update_billing_account_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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_billing_account( - cloud_billing.UpdateBillingAccountRequest(), - name='name_value', - account=cloud_billing.BillingAccount(name='name_value'), - ) - - -def test_update_billing_account_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.CreateBillingAccountRequest, - dict, -]) -def test_create_billing_account_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request_init["billing_account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount( - name='name_value', - open_=True, - display_name='display_name_value', - master_billing_account='master_billing_account_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.BillingAccount) - assert response.name == 'name_value' - assert response.open_ is True - assert response.display_name == 'display_name_value' - assert response.master_billing_account == 'master_billing_account_value' - - -def test_create_billing_account_rest_required_fields(request_type=cloud_billing.CreateBillingAccountRequest): - transport_class = transports.CloudBillingRestTransport - - 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()).create_billing_account._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()).create_billing_account._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_billing_account_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_billing_account._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("billingAccount", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_billing_account_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_create_billing_account") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_create_billing_account") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.CreateBillingAccountRequest.pb(cloud_billing.CreateBillingAccountRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.BillingAccount.to_json(cloud_billing.BillingAccount()) - - request = cloud_billing.CreateBillingAccountRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.BillingAccount() - - client.create_billing_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_create_billing_account_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.CreateBillingAccountRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request_init["billing_account"] = {'name': 'name_value', 'open_': True, 'display_name': 'display_name_value', 'master_billing_account': 'master_billing_account_value'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.create_billing_account(request) - - -def test_create_billing_account_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.BillingAccount() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - billing_account=cloud_billing.BillingAccount(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.BillingAccount.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.create_billing_account(**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/billingAccounts" % client.transport._host, args[1]) - - -def test_create_billing_account_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_billing_account( - cloud_billing.CreateBillingAccountRequest(), - billing_account=cloud_billing.BillingAccount(name='name_value'), - ) - - -def test_create_billing_account_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.ListProjectBillingInfoRequest, - dict, -]) -def test_list_project_billing_info_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ListProjectBillingInfoResponse( - 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 = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListProjectBillingInfoPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_project_billing_info_rest_required_fields(request_type=cloud_billing.ListProjectBillingInfoRequest): - transport_class = transports.CloudBillingRestTransport - - 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()).list_project_billing_info._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()).list_project_billing_info._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("page_size", "page_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ListProjectBillingInfoResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_project_billing_info_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_project_billing_info._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_project_billing_info_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_list_project_billing_info") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_list_project_billing_info") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.ListProjectBillingInfoRequest.pb(cloud_billing.ListProjectBillingInfoRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.ListProjectBillingInfoResponse.to_json(cloud_billing.ListProjectBillingInfoResponse()) - - request = cloud_billing.ListProjectBillingInfoRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.ListProjectBillingInfoResponse() - - client.list_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.ListProjectBillingInfoRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'billingAccounts/sample1'} - 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_project_billing_info(request) - - -def test_list_project_billing_info_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ListProjectBillingInfoResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.ListProjectBillingInfoResponse.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_project_billing_info(**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=billingAccounts/*}/projects" % client.transport._host, args[1]) - - -def test_list_project_billing_info_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.ListProjectBillingInfoRequest(), - name='name_value', - ) - - -def test_list_project_billing_info_rest_pager(transport: str = 'rest'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='abc', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[], - next_page_token='def', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - ], - next_page_token='ghi', - ), - cloud_billing.ListProjectBillingInfoResponse( - project_billing_info=[ - cloud_billing.ProjectBillingInfo(), - cloud_billing.ProjectBillingInfo(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(cloud_billing.ListProjectBillingInfoResponse.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 = {'name': 'billingAccounts/sample1'} - - pager = client.list_project_billing_info(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_billing.ProjectBillingInfo) - for i in results) - - pages = list(client.list_project_billing_info(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.GetProjectBillingInfoRequest, - dict, -]) -def test_get_project_billing_info_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -def test_get_project_billing_info_rest_required_fields(request_type=cloud_billing.GetProjectBillingInfoRequest): - transport_class = transports.CloudBillingRestTransport - - 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_project_billing_info._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_project_billing_info._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 = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_project_billing_info_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_project_billing_info._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_project_billing_info_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_project_billing_info") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_project_billing_info") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.GetProjectBillingInfoRequest.pb(cloud_billing.GetProjectBillingInfoRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.ProjectBillingInfo.to_json(cloud_billing.ProjectBillingInfo()) - - request = cloud_billing.GetProjectBillingInfoRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.ProjectBillingInfo() - - client.get_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.GetProjectBillingInfoRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1'} - 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_project_billing_info(request) - - -def test_get_project_billing_info_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.ProjectBillingInfo.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_project_billing_info(**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/*}/billingInfo" % client.transport._host, args[1]) - - -def test_get_project_billing_info_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.GetProjectBillingInfoRequest(), - name='name_value', - ) - - -def test_get_project_billing_info_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_billing.UpdateProjectBillingInfoRequest, - dict, -]) -def test_update_project_billing_info_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1'} - request_init["project_billing_info"] = {'name': 'name_value', 'project_id': 'project_id_value', 'billing_account_name': 'billing_account_name_value', 'billing_enabled': True} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo( - name='name_value', - project_id='project_id_value', - billing_account_name='billing_account_name_value', - billing_enabled=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_billing.ProjectBillingInfo) - assert response.name == 'name_value' - assert response.project_id == 'project_id_value' - assert response.billing_account_name == 'billing_account_name_value' - assert response.billing_enabled is True - - -def test_update_project_billing_info_rest_required_fields(request_type=cloud_billing.UpdateProjectBillingInfoRequest): - transport_class = transports.CloudBillingRestTransport - - 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()).update_project_billing_info._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()).update_project_billing_info._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 = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo() - # 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': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_project_billing_info_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_project_billing_info._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_project_billing_info_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_update_project_billing_info") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_update_project_billing_info") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_billing.UpdateProjectBillingInfoRequest.pb(cloud_billing.UpdateProjectBillingInfoRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_billing.ProjectBillingInfo.to_json(cloud_billing.ProjectBillingInfo()) - - request = cloud_billing.UpdateProjectBillingInfoRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_billing.ProjectBillingInfo() - - client.update_project_billing_info(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_project_billing_info_rest_bad_request(transport: str = 'rest', request_type=cloud_billing.UpdateProjectBillingInfoRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1'} - request_init["project_billing_info"] = {'name': 'name_value', 'project_id': 'project_id_value', 'billing_account_name': 'billing_account_name_value', 'billing_enabled': True} - 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_project_billing_info(request) - - -def test_update_project_billing_info_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_billing.ProjectBillingInfo() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_billing.ProjectBillingInfo.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.update_project_billing_info(**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/*}/billingInfo" % client.transport._host, args[1]) - - -def test_update_project_billing_info_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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_project_billing_info( - cloud_billing.UpdateProjectBillingInfoRequest(), - name='name_value', - project_billing_info=cloud_billing.ProjectBillingInfo(name='name_value'), - ) - - -def test_update_project_billing_info_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.GetIamPolicyRequest, - dict, -]) -def test_get_iam_policy_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = 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_iam_policy(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_get_iam_policy_rest_required_fields(request_type=iam_policy_pb2.GetIamPolicyRequest): - transport_class = transports.CloudBillingRestTransport - - request_init = {} - request_init["resource"] = "" - request = request_type(**request_init) - pb_request = 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_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("options", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = 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_iam_policy(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_iam_policy_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_iam_policy._get_unset_required_fields({}) - assert set(unset_fields) == (set(("options", )) & set(("resource", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_iam_policy_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_get_iam_policy") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_get_iam_policy") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = iam_policy_pb2.GetIamPolicyRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) - - request = iam_policy_pb2.GetIamPolicyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = policy_pb2.Policy() - - client.get_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_iam_policy_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.GetIamPolicyRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - 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_iam_policy(request) - - -def test_get_iam_policy_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - - # get arguments that satisfy an http rule for this method - sample_request = {'resource': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - resource='resource_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = 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_iam_policy(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{resource=billingAccounts/*}:getIamPolicy" % client.transport._host, args[1]) - - -def test_get_iam_policy_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - - -def test_get_iam_policy_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.SetIamPolicyRequest, - dict, -]) -def test_set_iam_policy_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = 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.set_iam_policy(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_set_iam_policy_rest_required_fields(request_type=iam_policy_pb2.SetIamPolicyRequest): - transport_class = transports.CloudBillingRestTransport - - request_init = {} - request_init["resource"] = "" - request = request_type(**request_init) - pb_request = 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()).set_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = 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.set_iam_policy(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_iam_policy_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_iam_policy._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("resource", "policy", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_iam_policy_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_set_iam_policy") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_set_iam_policy") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = iam_policy_pb2.SetIamPolicyRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) - - request = iam_policy_pb2.SetIamPolicyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = policy_pb2.Policy() - - client.set_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_iam_policy_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.SetIamPolicyRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - 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.set_iam_policy(request) - - -def test_set_iam_policy_rest_flattened(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - - # get arguments that satisfy an http rule for this method - sample_request = {'resource': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - resource='resource_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = 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.set_iam_policy(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{resource=billingAccounts/*}:setIamPolicy" % client.transport._host, args[1]) - - -def test_set_iam_policy_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - - -def test_set_iam_policy_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.TestIamPermissionsRequest, - dict, -]) -def test_test_iam_permissions_rest(request_type): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = 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.test_iam_permissions(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -def test_test_iam_permissions_rest_required_fields(request_type=iam_policy_pb2.TestIamPermissionsRequest): - transport_class = transports.CloudBillingRestTransport - - request_init = {} - request_init["resource"] = "" - request_init["permissions"] = "" - request = request_type(**request_init) - pb_request = request - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - 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()).test_iam_permissions._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - jsonified_request["permissions"] = 'permissions_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - assert "permissions" in jsonified_request - assert jsonified_request["permissions"] == 'permissions_value' - - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = iam_policy_pb2.TestIamPermissionsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = 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.test_iam_permissions(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_test_iam_permissions_rest_unset_required_fields(): - transport = transports.CloudBillingRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("resource", "permissions", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_test_iam_permissions_rest_interceptors(null_interceptor): - transport = transports.CloudBillingRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudBillingRestInterceptor(), - ) - client = CloudBillingClient(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.CloudBillingRestInterceptor, "post_test_iam_permissions") as post, \ - mock.patch.object(transports.CloudBillingRestInterceptor, "pre_test_iam_permissions") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = iam_policy_pb2.TestIamPermissionsRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(iam_policy_pb2.TestIamPermissionsResponse()) - - request = iam_policy_pb2.TestIamPermissionsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = iam_policy_pb2.TestIamPermissionsResponse() - - client.test_iam_permissions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_test_iam_permissions_rest_bad_request(transport: str = 'rest', request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'billingAccounts/sample1'} - 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.test_iam_permissions(request) - - -def test_test_iam_permissions_rest_flattened(): - client = CloudBillingClient( - 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 = iam_policy_pb2.TestIamPermissionsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'resource': 'billingAccounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - resource='resource_value', - permissions=['permissions_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 = 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.test_iam_permissions(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{resource=billingAccounts/*}:testIamPermissions" % client.transport._host, args[1]) - - -def test_test_iam_permissions_rest_flattened_error(transport: str = 'rest'): - client = CloudBillingClient( - 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.test_iam_permissions( - iam_policy_pb2.TestIamPermissionsRequest(), - resource='resource_value', - permissions=['permissions_value'], - ) - - -def test_test_iam_permissions_rest_error(): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudBillingClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = CloudBillingClient( - 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 = CloudBillingClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudBillingClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = CloudBillingClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.CloudBillingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.CloudBillingGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.CloudBillingGrpcTransport, - transports.CloudBillingGrpcAsyncIOTransport, - transports.CloudBillingRestTransport, -]) -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 = CloudBillingClient.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 = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.CloudBillingGrpcTransport, - ) - -def test_cloud_billing_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.CloudBillingTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_cloud_billing_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.billing_v1.services.cloud_billing.transports.CloudBillingTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.CloudBillingTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'get_billing_account', - 'list_billing_accounts', - 'update_billing_account', - 'create_billing_account', - 'list_project_billing_info', - 'get_project_billing_info', - 'update_project_billing_info', - 'get_iam_policy', - 'set_iam_policy', - 'test_iam_permissions', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_cloud_billing_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.billing_v1.services.cloud_billing.transports.CloudBillingTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.CloudBillingTransport( - 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-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_cloud_billing_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.billing_v1.services.cloud_billing.transports.CloudBillingTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.CloudBillingTransport() - adc.assert_called_once() - - -def test_cloud_billing_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) - CloudBillingClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.CloudBillingGrpcTransport, - transports.CloudBillingGrpcAsyncIOTransport, - ], -) -def test_cloud_billing_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-billing', 'https://www.googleapis.com/auth/cloud-billing.readonly', 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.CloudBillingGrpcTransport, - transports.CloudBillingGrpcAsyncIOTransport, - transports.CloudBillingRestTransport, - ], -) -def test_cloud_billing_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.CloudBillingGrpcTransport, grpc_helpers), - (transports.CloudBillingGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_cloud_billing_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( - "cloudbilling.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="cloudbilling.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) -def test_cloud_billing_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_cloud_billing_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.CloudBillingRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_cloud_billing_host_no_port(transport_name): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://cloudbilling.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_cloud_billing_host_with_port(transport_name): - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'cloudbilling.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://cloudbilling.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_cloud_billing_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = CloudBillingClient( - credentials=creds1, - transport=transport_name, - ) - client2 = CloudBillingClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.get_billing_account._session - session2 = client2.transport.get_billing_account._session - assert session1 != session2 - session1 = client1.transport.list_billing_accounts._session - session2 = client2.transport.list_billing_accounts._session - assert session1 != session2 - session1 = client1.transport.update_billing_account._session - session2 = client2.transport.update_billing_account._session - assert session1 != session2 - session1 = client1.transport.create_billing_account._session - session2 = client2.transport.create_billing_account._session - assert session1 != session2 - session1 = client1.transport.list_project_billing_info._session - session2 = client2.transport.list_project_billing_info._session - assert session1 != session2 - session1 = client1.transport.get_project_billing_info._session - session2 = client2.transport.get_project_billing_info._session - assert session1 != session2 - session1 = client1.transport.update_project_billing_info._session - session2 = client2.transport.update_project_billing_info._session - assert session1 != session2 - session1 = client1.transport.get_iam_policy._session - session2 = client2.transport.get_iam_policy._session - assert session1 != session2 - session1 = client1.transport.set_iam_policy._session - session2 = client2.transport.set_iam_policy._session - assert session1 != session2 - session1 = client1.transport.test_iam_permissions._session - session2 = client2.transport.test_iam_permissions._session - assert session1 != session2 -def test_cloud_billing_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.CloudBillingGrpcTransport( - 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_cloud_billing_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.CloudBillingGrpcAsyncIOTransport( - 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.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) -def test_cloud_billing_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.CloudBillingGrpcTransport, transports.CloudBillingGrpcAsyncIOTransport]) -def test_cloud_billing_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_project_billing_info_path(): - project = "squid" - expected = "projects/{project}/billingInfo".format(project=project, ) - actual = CloudBillingClient.project_billing_info_path(project) - assert expected == actual - - -def test_parse_project_billing_info_path(): - expected = { - "project": "clam", - } - path = CloudBillingClient.project_billing_info_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.parse_project_billing_info_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "whelk" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = CloudBillingClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "octopus", - } - path = CloudBillingClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "oyster" - expected = "folders/{folder}".format(folder=folder, ) - actual = CloudBillingClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nudibranch", - } - path = CloudBillingClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization, ) - actual = CloudBillingClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "mussel", - } - path = CloudBillingClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "winkle" - expected = "projects/{project}".format(project=project, ) - actual = CloudBillingClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "nautilus", - } - path = CloudBillingClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "scallop" - location = "abalone" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = CloudBillingClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "squid", - "location": "clam", - } - path = CloudBillingClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = CloudBillingClient.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.CloudBillingTransport, '_prep_wrapped_messages') as prep: - client = CloudBillingClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.CloudBillingTransport, '_prep_wrapped_messages') as prep: - transport_class = CloudBillingClient.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 = CloudBillingAsyncClient( - 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 = CloudBillingClient( - 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 = CloudBillingClient( - 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", [ - (CloudBillingClient, transports.CloudBillingGrpcTransport), - (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport), -]) -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/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py b/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py deleted file mode 100644 index dc54820e7912..000000000000 --- a/owl-bot-staging/google-cloud-billing/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py +++ /dev/null @@ -1,2385 +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 gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.billing_v1.services.cloud_catalog import CloudCatalogAsyncClient -from google.cloud.billing_v1.services.cloud_catalog import CloudCatalogClient -from google.cloud.billing_v1.services.cloud_catalog import pagers -from google.cloud.billing_v1.services.cloud_catalog import transports -from google.cloud.billing_v1.types import cloud_catalog -from google.oauth2 import service_account -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert CloudCatalogClient._get_default_mtls_endpoint(None) is None - assert CloudCatalogClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert CloudCatalogClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert CloudCatalogClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert CloudCatalogClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert CloudCatalogClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (CloudCatalogClient, "grpc"), - (CloudCatalogAsyncClient, "grpc_asyncio"), - (CloudCatalogClient, "rest"), -]) -def test_cloud_catalog_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 == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://cloudbilling.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.CloudCatalogGrpcTransport, "grpc"), - (transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.CloudCatalogRestTransport, "rest"), -]) -def test_cloud_catalog_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", [ - (CloudCatalogClient, "grpc"), - (CloudCatalogAsyncClient, "grpc_asyncio"), - (CloudCatalogClient, "rest"), -]) -def test_cloud_catalog_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 == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://cloudbilling.googleapis.com' - ) - - -def test_cloud_catalog_client_get_transport_class(): - transport = CloudCatalogClient.get_transport_class() - available_transports = [ - transports.CloudCatalogGrpcTransport, - transports.CloudCatalogRestTransport, - ] - assert transport in available_transports - - transport = CloudCatalogClient.get_transport_class("grpc") - assert transport == transports.CloudCatalogGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), - (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest"), -]) -@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) -@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) -def test_cloud_catalog_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(CloudCatalogClient, '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(CloudCatalogClient, '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", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", "true"), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", "false"), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", "true"), - (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", "false"), -]) -@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) -@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_cloud_catalog_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", [ - CloudCatalogClient, CloudCatalogAsyncClient -]) -@mock.patch.object(CloudCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogClient)) -@mock.patch.object(CloudCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudCatalogAsyncClient)) -def test_cloud_catalog_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", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), - (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest"), -]) -def test_cloud_catalog_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", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", grpc_helpers), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (CloudCatalogClient, transports.CloudCatalogRestTransport, "rest", None), -]) -def test_cloud_catalog_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_cloud_catalog_client_client_options_from_dict(): - with mock.patch('google.cloud.billing_v1.services.cloud_catalog.transports.CloudCatalogGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = CloudCatalogClient( - 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", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc", grpc_helpers), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_cloud_catalog_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( - "cloudbilling.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="cloudbilling.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - cloud_catalog.ListServicesRequest, - dict, -]) -def test_list_services(request_type, transport: str = 'grpc'): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_services), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_catalog.ListServicesResponse( - next_page_token='next_page_token_value', - ) - response = client.list_services(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListServicesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListServicesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_services_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 = CloudCatalogClient( - 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_services), - '__call__') as call: - client.list_services() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListServicesRequest() - -@pytest.mark.asyncio -async def test_list_services_async(transport: str = 'grpc_asyncio', request_type=cloud_catalog.ListServicesRequest): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_services), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListServicesResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_services(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListServicesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListServicesAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_services_async_from_dict(): - await test_list_services_async(request_type=dict) - - -def test_list_services_pager(transport_name: str = "grpc"): - client = CloudCatalogClient( - 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_services), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - next_page_token='abc', - ), - cloud_catalog.ListServicesResponse( - services=[], - next_page_token='def', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - ), - RuntimeError, - ) - - metadata = () - pager = client.list_services(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_catalog.Service) - for i in results) -def test_list_services_pages(transport_name: str = "grpc"): - client = CloudCatalogClient( - 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_services), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - next_page_token='abc', - ), - cloud_catalog.ListServicesResponse( - services=[], - next_page_token='def', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - ), - RuntimeError, - ) - pages = list(client.list_services(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_services_async_pager(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_services), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - next_page_token='abc', - ), - cloud_catalog.ListServicesResponse( - services=[], - next_page_token='def', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_services(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, cloud_catalog.Service) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_services_async_pages(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_services), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - next_page_token='abc', - ), - cloud_catalog.ListServicesResponse( - services=[], - next_page_token='def', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_services(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - cloud_catalog.ListSkusRequest, - dict, -]) -def test_list_skus(request_type, transport: str = 'grpc'): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_skus), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_catalog.ListSkusResponse( - next_page_token='next_page_token_value', - ) - response = client.list_skus(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListSkusRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSkusPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_skus_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 = CloudCatalogClient( - 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_skus), - '__call__') as call: - client.list_skus() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListSkusRequest() - -@pytest.mark.asyncio -async def test_list_skus_async(transport: str = 'grpc_asyncio', request_type=cloud_catalog.ListSkusRequest): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_skus), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_skus(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_catalog.ListSkusRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSkusAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_skus_async_from_dict(): - await test_list_skus_async(request_type=dict) - - -def test_list_skus_field_headers(): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_catalog.ListSkusRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__') as call: - call.return_value = cloud_catalog.ListSkusResponse() - client.list_skus(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_skus_field_headers_async(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = cloud_catalog.ListSkusRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse()) - await client.list_skus(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_skus_flattened(): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_catalog.ListSkusResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_skus( - 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_skus_flattened_error(): - client = CloudCatalogClient( - 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_skus( - cloud_catalog.ListSkusRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_skus_flattened_async(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_catalog.ListSkusResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_catalog.ListSkusResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_skus( - 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_skus_flattened_error_async(): - client = CloudCatalogAsyncClient( - 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_skus( - cloud_catalog.ListSkusRequest(), - parent='parent_value', - ) - - -def test_list_skus_pager(transport_name: str = "grpc"): - client = CloudCatalogClient( - 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_skus), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - next_page_token='abc', - ), - cloud_catalog.ListSkusResponse( - skus=[], - next_page_token='def', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_skus(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_catalog.Sku) - for i in results) -def test_list_skus_pages(transport_name: str = "grpc"): - client = CloudCatalogClient( - 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_skus), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - next_page_token='abc', - ), - cloud_catalog.ListSkusResponse( - skus=[], - next_page_token='def', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - ), - RuntimeError, - ) - pages = list(client.list_skus(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_skus_async_pager(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - next_page_token='abc', - ), - cloud_catalog.ListSkusResponse( - skus=[], - next_page_token='def', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_skus(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, cloud_catalog.Sku) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_skus_async_pages(): - client = CloudCatalogAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_skus), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - next_page_token='abc', - ), - cloud_catalog.ListSkusResponse( - skus=[], - next_page_token='def', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_skus(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - cloud_catalog.ListServicesRequest, - dict, -]) -def test_list_services_rest(request_type): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_catalog.ListServicesResponse( - 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 = cloud_catalog.ListServicesResponse.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_services(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListServicesPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_services_rest_interceptors(null_interceptor): - transport = transports.CloudCatalogRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudCatalogRestInterceptor(), - ) - client = CloudCatalogClient(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.CloudCatalogRestInterceptor, "post_list_services") as post, \ - mock.patch.object(transports.CloudCatalogRestInterceptor, "pre_list_services") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_catalog.ListServicesRequest.pb(cloud_catalog.ListServicesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_catalog.ListServicesResponse.to_json(cloud_catalog.ListServicesResponse()) - - request = cloud_catalog.ListServicesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_catalog.ListServicesResponse() - - client.list_services(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_services_rest_bad_request(transport: str = 'rest', request_type=cloud_catalog.ListServicesRequest): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - 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_services(request) - - -def test_list_services_rest_pager(transport: str = 'rest'): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - next_page_token='abc', - ), - cloud_catalog.ListServicesResponse( - services=[], - next_page_token='def', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListServicesResponse( - services=[ - cloud_catalog.Service(), - cloud_catalog.Service(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(cloud_catalog.ListServicesResponse.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 = {} - - pager = client.list_services(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_catalog.Service) - for i in results) - - pages = list(client.list_services(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - cloud_catalog.ListSkusRequest, - dict, -]) -def test_list_skus_rest(request_type): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'services/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_catalog.ListSkusResponse( - 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 = cloud_catalog.ListSkusResponse.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_skus(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListSkusPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_skus_rest_required_fields(request_type=cloud_catalog.ListSkusRequest): - transport_class = transports.CloudCatalogRestTransport - - 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_skus._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_skus._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("currency_code", "end_time", "page_size", "page_token", "start_time", )) - 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 = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = cloud_catalog.ListSkusResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = cloud_catalog.ListSkusResponse.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_skus(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_skus_rest_unset_required_fields(): - transport = transports.CloudCatalogRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_skus._get_unset_required_fields({}) - assert set(unset_fields) == (set(("currencyCode", "endTime", "pageSize", "pageToken", "startTime", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_skus_rest_interceptors(null_interceptor): - transport = transports.CloudCatalogRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.CloudCatalogRestInterceptor(), - ) - client = CloudCatalogClient(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.CloudCatalogRestInterceptor, "post_list_skus") as post, \ - mock.patch.object(transports.CloudCatalogRestInterceptor, "pre_list_skus") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = cloud_catalog.ListSkusRequest.pb(cloud_catalog.ListSkusRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = cloud_catalog.ListSkusResponse.to_json(cloud_catalog.ListSkusResponse()) - - request = cloud_catalog.ListSkusRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = cloud_catalog.ListSkusResponse() - - client.list_skus(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_skus_rest_bad_request(transport: str = 'rest', request_type=cloud_catalog.ListSkusRequest): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'services/sample1'} - 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_skus(request) - - -def test_list_skus_rest_flattened(): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = cloud_catalog.ListSkusResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'services/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = cloud_catalog.ListSkusResponse.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_skus(**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=services/*}/skus" % client.transport._host, args[1]) - - -def test_list_skus_rest_flattened_error(transport: str = 'rest'): - client = CloudCatalogClient( - 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_skus( - cloud_catalog.ListSkusRequest(), - parent='parent_value', - ) - - -def test_list_skus_rest_pager(transport: str = 'rest'): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - next_page_token='abc', - ), - cloud_catalog.ListSkusResponse( - skus=[], - next_page_token='def', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - ], - next_page_token='ghi', - ), - cloud_catalog.ListSkusResponse( - skus=[ - cloud_catalog.Sku(), - cloud_catalog.Sku(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(cloud_catalog.ListSkusResponse.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': 'services/sample1'} - - pager = client.list_skus(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, cloud_catalog.Sku) - for i in results) - - pages = list(client.list_skus(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudCatalogClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = CloudCatalogClient( - 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 = CloudCatalogClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CloudCatalogClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = CloudCatalogClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.CloudCatalogGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.CloudCatalogGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.CloudCatalogGrpcTransport, - transports.CloudCatalogGrpcAsyncIOTransport, - transports.CloudCatalogRestTransport, -]) -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 = CloudCatalogClient.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 = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.CloudCatalogGrpcTransport, - ) - -def test_cloud_catalog_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.CloudCatalogTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_cloud_catalog_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.CloudCatalogTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'list_services', - 'list_skus', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_cloud_catalog_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.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.CloudCatalogTransport( - 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-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_cloud_catalog_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.billing_v1.services.cloud_catalog.transports.CloudCatalogTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.CloudCatalogTransport() - adc.assert_called_once() - - -def test_cloud_catalog_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) - CloudCatalogClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.CloudCatalogGrpcTransport, - transports.CloudCatalogGrpcAsyncIOTransport, - ], -) -def test_cloud_catalog_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-billing', 'https://www.googleapis.com/auth/cloud-billing.readonly', 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.CloudCatalogGrpcTransport, - transports.CloudCatalogGrpcAsyncIOTransport, - transports.CloudCatalogRestTransport, - ], -) -def test_cloud_catalog_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.CloudCatalogGrpcTransport, grpc_helpers), - (transports.CloudCatalogGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_cloud_catalog_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( - "cloudbilling.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-billing', - 'https://www.googleapis.com/auth/cloud-billing.readonly', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="cloudbilling.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) -def test_cloud_catalog_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_cloud_catalog_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.CloudCatalogRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_cloud_catalog_host_no_port(transport_name): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'cloudbilling.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://cloudbilling.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_cloud_catalog_host_with_port(transport_name): - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'cloudbilling.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://cloudbilling.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_cloud_catalog_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = CloudCatalogClient( - credentials=creds1, - transport=transport_name, - ) - client2 = CloudCatalogClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.list_services._session - session2 = client2.transport.list_services._session - assert session1 != session2 - session1 = client1.transport.list_skus._session - session2 = client2.transport.list_skus._session - assert session1 != session2 -def test_cloud_catalog_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.CloudCatalogGrpcTransport( - 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_cloud_catalog_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.CloudCatalogGrpcAsyncIOTransport( - 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.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) -def test_cloud_catalog_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.CloudCatalogGrpcTransport, transports.CloudCatalogGrpcAsyncIOTransport]) -def test_cloud_catalog_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_service_path(): - service = "squid" - expected = "services/{service}".format(service=service, ) - actual = CloudCatalogClient.service_path(service) - assert expected == actual - - -def test_parse_service_path(): - expected = { - "service": "clam", - } - path = CloudCatalogClient.service_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.parse_service_path(path) - assert expected == actual - -def test_sku_path(): - service = "whelk" - sku = "octopus" - expected = "services/{service}/skus/{sku}".format(service=service, sku=sku, ) - actual = CloudCatalogClient.sku_path(service, sku) - assert expected == actual - - -def test_parse_sku_path(): - expected = { - "service": "oyster", - "sku": "nudibranch", - } - path = CloudCatalogClient.sku_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.parse_sku_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = CloudCatalogClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = CloudCatalogClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = CloudCatalogClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = CloudCatalogClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = CloudCatalogClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = CloudCatalogClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = CloudCatalogClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = CloudCatalogClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.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 = CloudCatalogClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = CloudCatalogClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = CloudCatalogClient.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.CloudCatalogTransport, '_prep_wrapped_messages') as prep: - client = CloudCatalogClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.CloudCatalogTransport, '_prep_wrapped_messages') as prep: - transport_class = CloudCatalogClient.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 = CloudCatalogAsyncClient( - 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 = CloudCatalogClient( - 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 = CloudCatalogClient( - 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", [ - (CloudCatalogClient, transports.CloudCatalogGrpcTransport), - (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport), -]) -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/packages/google-cloud-billing/google/cloud/billing/gapic_version.py b/packages/google-cloud-billing/google/cloud/billing/gapic_version.py index 6f9b28f95196..405b1cebcf15 100644 --- a/packages/google-cloud-billing/google/cloud/billing/gapic_version.py +++ b/packages/google-cloud-billing/google/cloud/billing/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.10.1" # {x-release-please-version} +__version__ = "0.1.0" # {x-release-please-version} diff --git a/packages/google-cloud-billing/google/cloud/billing_v1/gapic_version.py b/packages/google-cloud-billing/google/cloud/billing_v1/gapic_version.py index 6f9b28f95196..405b1cebcf15 100644 --- a/packages/google-cloud-billing/google/cloud/billing_v1/gapic_version.py +++ b/packages/google-cloud-billing/google/cloud/billing_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.10.1" # {x-release-please-version} +__version__ = "0.1.0" # {x-release-please-version} diff --git a/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/async_client.py b/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/async_client.py index 859d9c69f91c..d97105625bdc 100644 --- a/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/async_client.py +++ b/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/async_client.py @@ -63,6 +63,12 @@ class CloudBillingAsyncClient: DEFAULT_ENDPOINT = CloudBillingClient.DEFAULT_ENDPOINT DEFAULT_MTLS_ENDPOINT = CloudBillingClient.DEFAULT_MTLS_ENDPOINT + project_billing_info_path = staticmethod( + CloudBillingClient.project_billing_info_path + ) + parse_project_billing_info_path = staticmethod( + CloudBillingClient.parse_project_billing_info_path + ) common_billing_account_path = staticmethod( CloudBillingClient.common_billing_account_path ) diff --git a/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/client.py b/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/client.py index 703148adc13a..799c7f2ba67d 100644 --- a/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/client.py +++ b/packages/google-cloud-billing/google/cloud/billing_v1/services/cloud_billing/client.py @@ -180,6 +180,21 @@ def transport(self) -> CloudBillingTransport: """ return self._transport + @staticmethod + def project_billing_info_path( + project: str, + ) -> str: + """Returns a fully-qualified project_billing_info string.""" + return "projects/{project}/billingInfo".format( + project=project, + ) + + @staticmethod + def parse_project_billing_info_path(path: str) -> Dict[str, str]: + """Parses a project_billing_info path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/billingInfo$", path) + return m.groupdict() if m else {} + @staticmethod def common_billing_account_path( billing_account: str, diff --git a/packages/google-cloud-billing/google/cloud/billing_v1/types/cloud_billing.py b/packages/google-cloud-billing/google/cloud/billing_v1/types/cloud_billing.py index cb3f2ca65458..9c1770135931 100644 --- a/packages/google-cloud-billing/google/cloud/billing_v1/types/cloud_billing.py +++ b/packages/google-cloud-billing/google/cloud/billing_v1/types/cloud_billing.py @@ -95,29 +95,31 @@ class ProjectBillingInfo(proto.Message): Attributes: name (str): - The resource name for the ``ProjectBillingInfo``; has the - form ``projects/{project_id}/billingInfo``. For example, the + Output only. The resource name for the + ``ProjectBillingInfo``; has the form + ``projects/{project_id}/billingInfo``. For example, the resource name for the billing information for project ``tokyo-rain-123`` would be ``projects/tokyo-rain-123/billingInfo``. This field is read-only. project_id (str): - The ID of the project that this ``ProjectBillingInfo`` - represents, such as ``tokyo-rain-123``. This is a - convenience field so that you don't need to parse the - ``name`` field to obtain a project ID. This field is - read-only. + Output only. The ID of the project that this + ``ProjectBillingInfo`` represents, such as + ``tokyo-rain-123``. This is a convenience field so that you + don't need to parse the ``name`` field to obtain a project + ID. This field is read-only. billing_account_name (str): The resource name of the billing account associated with the project, if any. For example, ``billingAccounts/012345-567890-ABCDEF``. billing_enabled (bool): - True if the project is associated with an - open billing account, to which usage on the - project is charged. False if the project is - associated with a closed billing account, or no - billing account at all, and therefore cannot use - paid services. This field is read-only. + Output only. True if the project is + associated with an open billing account, to + which usage on the project is charged. False if + the project is associated with a closed billing + account, or no billing account at all, and + therefore cannot use paid services. This field + is read-only. """ name: str = proto.Field( diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_create_billing_account_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_billing_account_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_iam_policy_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_get_project_billing_info_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_billing_accounts_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_list_project_billing_info_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_set_iam_policy_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_test_iam_permissions_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_billing_account_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_billing_update_project_billing_info_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_services_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_async.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py b/packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py rename to packages/google-cloud-billing/samples/generated_samples/cloudbilling_v1_generated_cloud_catalog_list_skus_sync.py diff --git a/owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json b/packages/google-cloud-billing/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json similarity index 100% rename from owl-bot-staging/google-cloud-billing/v1/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json rename to packages/google-cloud-billing/samples/generated_samples/snippet_metadata_google.cloud.billing.v1.json diff --git a/packages/google-cloud-billing/tests/unit/gapic/billing_v1/test_cloud_billing.py b/packages/google-cloud-billing/tests/unit/gapic/billing_v1/test_cloud_billing.py index 773658f2b8b8..96ebccdfaf1c 100644 --- a/packages/google-cloud-billing/tests/unit/gapic/billing_v1/test_cloud_billing.py +++ b/packages/google-cloud-billing/tests/unit/gapic/billing_v1/test_cloud_billing.py @@ -6779,8 +6779,28 @@ def test_cloud_billing_transport_channel_mtls_with_adc(transport_class): assert transport.grpc_channel == mock_grpc_channel +def test_project_billing_info_path(): + project = "squid" + expected = "projects/{project}/billingInfo".format( + project=project, + ) + actual = CloudBillingClient.project_billing_info_path(project) + assert expected == actual + + +def test_parse_project_billing_info_path(): + expected = { + "project": "clam", + } + path = CloudBillingClient.project_billing_info_path(**expected) + + # Check that the path construction is reversible. + actual = CloudBillingClient.parse_project_billing_info_path(path) + assert expected == actual + + def test_common_billing_account_path(): - billing_account = "squid" + billing_account = "whelk" expected = "billingAccounts/{billing_account}".format( billing_account=billing_account, ) @@ -6790,7 +6810,7 @@ def test_common_billing_account_path(): def test_parse_common_billing_account_path(): expected = { - "billing_account": "clam", + "billing_account": "octopus", } path = CloudBillingClient.common_billing_account_path(**expected) @@ -6800,7 +6820,7 @@ def test_parse_common_billing_account_path(): def test_common_folder_path(): - folder = "whelk" + folder = "oyster" expected = "folders/{folder}".format( folder=folder, ) @@ -6810,7 +6830,7 @@ def test_common_folder_path(): def test_parse_common_folder_path(): expected = { - "folder": "octopus", + "folder": "nudibranch", } path = CloudBillingClient.common_folder_path(**expected) @@ -6820,7 +6840,7 @@ def test_parse_common_folder_path(): def test_common_organization_path(): - organization = "oyster" + organization = "cuttlefish" expected = "organizations/{organization}".format( organization=organization, ) @@ -6830,7 +6850,7 @@ def test_common_organization_path(): def test_parse_common_organization_path(): expected = { - "organization": "nudibranch", + "organization": "mussel", } path = CloudBillingClient.common_organization_path(**expected) @@ -6840,7 +6860,7 @@ def test_parse_common_organization_path(): def test_common_project_path(): - project = "cuttlefish" + project = "winkle" expected = "projects/{project}".format( project=project, ) @@ -6850,7 +6870,7 @@ def test_common_project_path(): def test_parse_common_project_path(): expected = { - "project": "mussel", + "project": "nautilus", } path = CloudBillingClient.common_project_path(**expected) @@ -6860,8 +6880,8 @@ def test_parse_common_project_path(): def test_common_location_path(): - project = "winkle" - location = "nautilus" + project = "scallop" + location = "abalone" expected = "projects/{project}/locations/{location}".format( project=project, location=location, @@ -6872,8 +6892,8 @@ def test_common_location_path(): def test_parse_common_location_path(): expected = { - "project": "scallop", - "location": "abalone", + "project": "squid", + "location": "clam", } path = CloudBillingClient.common_location_path(**expected)