diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..c96c710 --- /dev/null +++ b/owl-bot-staging/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/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..d63a58d --- /dev/null +++ b/owl-bot-staging/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/v1/docs/billing_v1/cloud_billing.rst b/owl-bot-staging/v1/docs/billing_v1/cloud_billing.rst new file mode 100644 index 0000000..08631bd --- /dev/null +++ b/owl-bot-staging/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/v1/docs/billing_v1/cloud_catalog.rst b/owl-bot-staging/v1/docs/billing_v1/cloud_catalog.rst new file mode 100644 index 0000000..6795e65 --- /dev/null +++ b/owl-bot-staging/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/v1/docs/billing_v1/services.rst b/owl-bot-staging/v1/docs/billing_v1/services.rst new file mode 100644 index 0000000..db3c1f1 --- /dev/null +++ b/owl-bot-staging/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/v1/docs/billing_v1/types.rst b/owl-bot-staging/v1/docs/billing_v1/types.rst new file mode 100644 index 0000000..f51e922 --- /dev/null +++ b/owl-bot-staging/v1/docs/billing_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Billing v1 API +===================================== + +.. automodule:: google.cloud.billing_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..6d34659 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 = "1.6.3" + +# 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 master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-billing" +copyright = u"2020, 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 = [ + ( + master_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 = [ + ( + master_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 = [ + ( + master_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/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..ba505d0 --- /dev/null +++ b/owl-bot-staging/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/v1/google/cloud/billing/__init__.py b/owl-bot-staging/v1/google/cloud/billing/__init__.py new file mode 100644 index 0000000..ebf35ff --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing/__init__.py @@ -0,0 +1,68 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.services.cloud_billing.async_client import CloudBillingAsyncClient +from google.cloud.billing_v1.services.cloud_billing.client import CloudBillingClient +from google.cloud.billing_v1.services.cloud_catalog.async_client import CloudCatalogAsyncClient +from google.cloud.billing_v1.services.cloud_catalog.client import CloudCatalogClient +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 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__ = ('AggregationInfo', + 'BillingAccount', + 'Category', + 'CloudBillingAsyncClient', + 'CloudBillingClient', + 'CloudCatalogAsyncClient', + 'CloudCatalogClient', + 'CreateBillingAccountRequest', + 'GetBillingAccountRequest', + 'GetProjectBillingInfoRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + 'PricingExpression', + 'PricingInfo', + 'ProjectBillingInfo', + 'Service', + 'Sku', + 'UpdateBillingAccountRequest', + 'UpdateProjectBillingInfoRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/billing/py.typed b/owl-bot-staging/v1/google/cloud/billing/py.typed new file mode 100644 index 0000000..5e18615 --- /dev/null +++ b/owl-bot-staging/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/v1/google/cloud/billing_v1/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/__init__.py new file mode 100644 index 0000000..5ae3a1d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/__init__.py @@ -0,0 +1,66 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .services.cloud_billing import CloudBillingClient +from .services.cloud_catalog import CloudCatalogClient + +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 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__ = ( + 'AggregationInfo', + 'BillingAccount', + 'Category', + 'CloudBillingClient', + 'CreateBillingAccountRequest', + 'GetBillingAccountRequest', + 'GetProjectBillingInfoRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + 'PricingExpression', + 'PricingInfo', + 'ProjectBillingInfo', + 'Service', + 'Sku', + 'UpdateBillingAccountRequest', + 'UpdateProjectBillingInfoRequest', +'CloudCatalogClient', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/billing_v1/gapic_metadata.json new file mode 100644 index 0000000..94940c7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/gapic_metadata.json @@ -0,0 +1,157 @@ + { + "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" + ] + } + } + } + } + }, + "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" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/py.typed b/owl-bot-staging/v1/google/cloud/billing_v1/py.typed new file mode 100644 index 0000000..5e18615 --- /dev/null +++ b/owl-bot-staging/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/v1/google/cloud/billing_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py new file mode 100644 index 0000000..677877d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/__init__.py @@ -0,0 +1,22 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py new file mode 100644 index 0000000..72e0067 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/async_client.py @@ -0,0 +1,1202 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore +from google.oauth2 import service_account # 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 as iam_policy # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore +from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport +from .client import CloudBillingClient + + +class CloudBillingAsyncClient: + """Retrieves GCP Console billing accounts and associates them + with projects. + """ + + _client: CloudBillingClient + + DEFAULT_ENDPOINT = CloudBillingClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = CloudBillingClient.DEFAULT_MTLS_ENDPOINT + + 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 + + @property + def transport(self) -> CloudBillingTransport: + """Return 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: credentials.Credentials = None, + transport: Union[str, CloudBillingTransport] = 'grpc_asyncio', + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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: cloud_billing.GetBillingAccountRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 `__. + + Args: + request (:class:`google.cloud.billing_v1.types.GetBillingAccountRequest`): + 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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( + exceptions.DeadlineExceeded, + 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: cloud_billing.ListBillingAccountsRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListBillingAccountsAsyncPager: + r"""Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + Args: + request (:class:`google.cloud.billing_v1.types.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: + 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( + exceptions.DeadlineExceeded, + 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: cloud_billing.UpdateBillingAccountRequest = None, + *, + name: str = None, + account: cloud_billing.BillingAccount = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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. + + Args: + request (:class:`google.cloud.billing_v1.types.UpdateBillingAccountRequest`): + 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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( + exceptions.DeadlineExceeded, + 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: cloud_billing.CreateBillingAccountRequest = None, + *, + billing_account: cloud_billing.BillingAccount = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Creates a billing account. This method can only be used to + create `billing + subaccounts `__ + by GCP resellers. When creating a subaccount, the current + authenticated user must have the ``billing.accounts.update`` IAM + permission on the master account, which is typically given to + billing account + `administrators `__. + This method will return an error if the master account has not + been provisioned as a reseller account. + + Args: + request (:class:`google.cloud.billing_v1.types.CreateBillingAccountRequest`): + 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 master 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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: cloud_billing.ListProjectBillingInfoRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 `__. + + Args: + request (:class:`google.cloud.billing_v1.types.ListProjectBillingInfoRequest`): + 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. + # Sanity 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( + exceptions.DeadlineExceeded, + 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: cloud_billing.GetProjectBillingInfoRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Gets the billing information for a project. The current + authenticated user must have `permission to view the + project `__. + + Args: + request (:class:`google.cloud.billing_v1.types.GetProjectBillingInfoRequest`): + 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 GCP 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. + # Sanity 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( + exceptions.DeadlineExceeded, + 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: cloud_billing.UpdateProjectBillingInfoRequest = None, + *, + name: str = None, + project_billing_info: cloud_billing.ProjectBillingInfo = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 GCP 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. + + Args: + request (:class:`google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest`): + 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 GCP 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. + # Sanity 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( + exceptions.DeadlineExceeded, + 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: iam_policy.GetIamPolicyRequest = None, + *, + resource: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gi_policy.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 `__. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.GetIamPolicyRequest`): + 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: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **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')", } } + + ] + + } + + **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') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # Sanity 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.GetIamPolicyRequest(**request) + elif not request: + request = iam_policy.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( + exceptions.DeadlineExceeded, + 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: iam_policy.SetIamPolicyRequest = None, + *, + resource: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gi_policy.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 `__. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.SetIamPolicyRequest`): + 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: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **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')", } } + + ] + + } + + **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') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # Sanity 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.SetIamPolicyRequest(**request) + elif not request: + request = iam_policy.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( + exceptions.DeadlineExceeded, + 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: iam_policy.TestIamPermissionsRequest = None, + *, + resource: str = None, + permissions: Sequence[str] = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy.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. + + Args: + request (:class:`google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest`): + 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:`Sequence[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. + # Sanity 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.TestIamPermissionsRequest(**request) + elif not request: + request = iam_policy.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( + exceptions.DeadlineExceeded, + 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'CloudBillingAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/client.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/client.py new file mode 100644 index 0000000..dc6132a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/client.py @@ -0,0 +1,1308 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import 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 + +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 as iam_policy # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore +from .transports.base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import CloudBillingGrpcTransport +from .transports.grpc_asyncio import CloudBillingGrpcAsyncIOTransport + + +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 + + def get_transport_class(cls, + label: str = None, + ) -> Type[CloudBillingTransport]: + """Return 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 GCP Console billing accounts and associates them + with projects. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Convert 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: + """Return the transport used by the client instance. + + Returns: + CloudBillingTransport: The transport used by the client instance. + """ + return self._transport + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Return 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: + """Return 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: + """Return 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: + """Return 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: + """Return 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 {} + + def __init__(self, *, + credentials: Optional[credentials.Credentials] = None, + transport: Union[str, CloudBillingTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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 (google.api_core.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. + 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() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + client_cert_source_func = mtls.default_client_cert_source() if is_mtls else None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT if is_mtls else self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always" + ) + + # 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: + 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: + 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, + ) + + def get_billing_account(self, + request: cloud_billing.GetBillingAccountRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 `__. + + Args: + request (google.cloud.billing_v1.types.GetBillingAccountRequest): + 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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: cloud_billing.ListBillingAccountsRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListBillingAccountsPager: + r"""Lists the billing accounts that the current authenticated user + has permission to + `view `__. + + Args: + request (google.cloud.billing_v1.types.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: + 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: cloud_billing.UpdateBillingAccountRequest = None, + *, + name: str = None, + account: cloud_billing.BillingAccount = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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. + + Args: + request (google.cloud.billing_v1.types.UpdateBillingAccountRequest): + 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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: cloud_billing.CreateBillingAccountRequest = None, + *, + billing_account: cloud_billing.BillingAccount = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.BillingAccount: + r"""Creates a billing account. This method can only be used to + create `billing + subaccounts `__ + by GCP resellers. When creating a subaccount, the current + authenticated user must have the ``billing.accounts.update`` IAM + permission on the master account, which is typically given to + billing account + `administrators `__. + This method will return an error if the master account has not + been provisioned as a reseller account. + + Args: + request (google.cloud.billing_v1.types.CreateBillingAccountRequest): + 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 master 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 [GCP Console](\ https://console.cloud.google.com/). + You can assign a billing account to one or more + projects. + + """ + # Create or coerce a protobuf request object. + # Sanity 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: cloud_billing.ListProjectBillingInfoRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 `__. + + Args: + request (google.cloud.billing_v1.types.ListProjectBillingInfoRequest): + 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. + # Sanity 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: cloud_billing.GetProjectBillingInfoRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_billing.ProjectBillingInfo: + r"""Gets the billing information for a project. The current + authenticated user must have `permission to view the + project `__. + + Args: + request (google.cloud.billing_v1.types.GetProjectBillingInfoRequest): + 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 GCP 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. + # Sanity 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: cloud_billing.UpdateProjectBillingInfoRequest = None, + *, + name: str = None, + project_billing_info: cloud_billing.ProjectBillingInfo = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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 GCP 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. + + Args: + request (google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest): + 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 GCP 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. + # Sanity 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: iam_policy.GetIamPolicyRequest = None, + *, + resource: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gi_policy.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 `__. + + Args: + request (google.iam.v1.iam_policy_pb2.GetIamPolicyRequest): + 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: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **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')", } } + + ] + + } + + **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') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # Sanity 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.GetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy.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: iam_policy.SetIamPolicyRequest = None, + *, + resource: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gi_policy.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 `__. + + Args: + request (google.iam.v1.iam_policy_pb2.SetIamPolicyRequest): + 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: + Defines an Identity and Access Management (IAM) policy. It is used to + specify access control policies for Cloud Platform + resources. + + A Policy is a collection of bindings. A binding binds + one or more members to a single role. Members can be + user accounts, service accounts, Google groups, and + domains (such as G Suite). A role is a named list of + permissions (defined by IAM or configured by users). + A binding can optionally specify a condition, which + is a logic expression that further constrains the + role binding based on attributes about the request + and/or target resource. + + **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')", } } + + ] + + } + + **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') + + For a description of IAM and its features, see the + [IAM developer's + guide](\ https://cloud.google.com/iam/docs). + + """ + # Create or coerce a protobuf request object. + # Sanity 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.SetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy.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: iam_policy.TestIamPermissionsRequest = None, + *, + resource: str = None, + permissions: Sequence[str] = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy.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. + + Args: + request (google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest): + 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 (Sequence[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. + # Sanity 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.TestIamPermissionsRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy.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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'CloudBillingClient', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py new file mode 100644 index 0000000..11a9165 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/pagers.py @@ -0,0 +1,262 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional + +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) -> Iterable[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) -> Iterable[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]] = ()): + """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 + async def pages(self) -> AsyncIterable[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) -> AsyncIterable[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) -> Iterable[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) -> Iterable[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]] = ()): + """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 + async def pages(self) -> AsyncIterable[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) -> AsyncIterable[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/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py new file mode 100644 index 0000000..83b4173 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/__init__.py @@ -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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[CloudBillingTransport]] +_transport_registry['grpc'] = CloudBillingGrpcTransport +_transport_registry['grpc_asyncio'] = CloudBillingGrpcAsyncIOTransport + +__all__ = ( + 'CloudBillingTransport', + 'CloudBillingGrpcTransport', + 'CloudBillingGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py new file mode 100644 index 0000000..d477e0c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/base.py @@ -0,0 +1,373 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 +import packaging.version +import pkg_resources + +from google import auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore + +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 as iam_policy # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + +_API_CORE_VERSION = google.api_core.__version__ + + +class CloudBillingTransport(abc.ABC): + """Abstract transport class for CloudBilling.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'cloudbilling.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: 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, + **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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): These two class methods are in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-api-core + # and google-auth are increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + # TODO: Remove this function once google-api-core >= 1.26.0 is required + @classmethod + def _get_self_signed_jwt_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Union[Optional[Sequence[str]], str]]: + """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" + + self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} + + if _API_CORE_VERSION and ( + packaging.version.parse(_API_CORE_VERSION) + >= packaging.version.parse("1.26.0") + ): + self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES + self_signed_jwt_kwargs["scopes"] = scopes + self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST + else: + self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES + + return self_signed_jwt_kwargs + + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + @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.GetIamPolicyRequest], + Union[ + gi_policy.Policy, + Awaitable[gi_policy.Policy] + ]]: + raise NotImplementedError() + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy.SetIamPolicyRequest], + Union[ + gi_policy.Policy, + Awaitable[gi_policy.Policy] + ]]: + raise NotImplementedError() + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy.TestIamPermissionsRequest], + Union[ + iam_policy.TestIamPermissionsResponse, + Awaitable[iam_policy.TestIamPermissionsResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'CloudBillingTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py new file mode 100644 index 0000000..4e3db53 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc.py @@ -0,0 +1,575 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google import auth # type: ignore +from google.auth import 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 as iam_policy # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore +from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO + + +class CloudBillingGrpcTransport(CloudBillingTransport): + """gRPC backend transport for CloudBilling. + + Retrieves GCP 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: credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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: credentials.Credentials = None, + credentials_file: 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. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **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. + + Creates a billing account. This method can only be used to + create `billing + subaccounts `__ + by GCP resellers. When creating a subaccount, the current + authenticated user must have the ``billing.accounts.update`` IAM + permission on the master account, which is typically given to + billing account + `administrators `__. + This method will return an error if the master 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 `permission to view the + project `__. + + 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 GCP 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.GetIamPolicyRequest], + gi_policy.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.GetIamPolicyRequest.SerializeToString, + response_deserializer=gi_policy.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy.SetIamPolicyRequest], + gi_policy.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.SetIamPolicyRequest.SerializeToString, + response_deserializer=gi_policy.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy.TestIamPermissionsRequest], + iam_policy.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.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + +__all__ = ( + 'CloudBillingGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py new file mode 100644 index 0000000..82f66db --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_billing/transports/grpc_asyncio.py @@ -0,0 +1,580 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google import auth # type: ignore +from google.auth import credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +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 as iam_policy # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore +from .base import CloudBillingTransport, DEFAULT_CLIENT_INFO +from .grpc import CloudBillingGrpcTransport + + +class CloudBillingGrpcAsyncIOTransport(CloudBillingTransport): + """gRPC AsyncIO backend transport for CloudBilling. + + Retrieves GCP 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: 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. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **kwargs + ) + + def __init__(self, *, + host: str = 'cloudbilling.googleapis.com', + credentials: credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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. + + Creates a billing account. This method can only be used to + create `billing + subaccounts `__ + by GCP resellers. When creating a subaccount, the current + authenticated user must have the ``billing.accounts.update`` IAM + permission on the master account, which is typically given to + billing account + `administrators `__. + This method will return an error if the master 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 `permission to view the + project `__. + + 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 GCP 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.GetIamPolicyRequest], + Awaitable[gi_policy.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.GetIamPolicyRequest.SerializeToString, + response_deserializer=gi_policy.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy.SetIamPolicyRequest], + Awaitable[gi_policy.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.SetIamPolicyRequest.SerializeToString, + response_deserializer=gi_policy.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy.TestIamPermissionsRequest], + Awaitable[iam_policy.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.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + +__all__ = ( + 'CloudBillingGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py new file mode 100644 index 0000000..bcffdd5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/__init__.py @@ -0,0 +1,22 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py new file mode 100644 index 0000000..6fd57d3 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/async_client.py @@ -0,0 +1,312 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore +from google.oauth2 import service_account # 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 + + @property + def transport(self) -> CloudCatalogTransport: + """Return 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: credentials.Credentials = None, + transport: Union[str, CloudCatalogTransport] = 'grpc_asyncio', + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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: cloud_catalog.ListServicesRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListServicesAsyncPager: + r"""Lists all public cloud services. + + Args: + request (:class:`google.cloud.billing_v1.types.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: + 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: cloud_catalog.ListSkusRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSkusAsyncPager: + r"""Lists all publicly available SKUs for a given cloud + service. + + Args: + request (:class:`google.cloud.billing_v1.types.ListSkusRequest`): + 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. + # Sanity 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'CloudCatalogAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/client.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/client.py new file mode 100644 index 0000000..e2bdcd3 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/client.py @@ -0,0 +1,500 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import 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 + +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 + + +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 + + def get_transport_class(cls, + label: str = None, + ) -> Type[CloudCatalogTransport]: + """Return 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): + """Convert 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: + """Return 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: + """Return a fully-qualified service string.""" + return "services/{service}".format(service=service, ) + + @staticmethod + def parse_service_path(path: str) -> Dict[str,str]: + """Parse 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: + """Return 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]: + """Parse 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: + """Return 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: + """Return 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: + """Return 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: + """Return 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: + """Return 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 {} + + def __init__(self, *, + credentials: Optional[credentials.Credentials] = None, + transport: Union[str, CloudCatalogTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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 (google.api_core.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. + 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() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + client_cert_source_func = mtls.default_client_cert_source() if is_mtls else None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT if is_mtls else self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always" + ) + + # 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: + 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: + 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, + ) + + def list_services(self, + request: cloud_catalog.ListServicesRequest = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListServicesPager: + r"""Lists all public cloud services. + + Args: + request (google.cloud.billing_v1.types.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: + 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: cloud_catalog.ListSkusRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSkusPager: + r"""Lists all publicly available SKUs for a given cloud + service. + + Args: + request (google.cloud.billing_v1.types.ListSkusRequest): + 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. + # Sanity 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'CloudCatalogClient', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py new file mode 100644 index 0000000..2f569da --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/pagers.py @@ -0,0 +1,262 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional + +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) -> Iterable[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) -> Iterable[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]] = ()): + """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 + async def pages(self) -> AsyncIterable[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) -> AsyncIterable[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) -> Iterable[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) -> Iterable[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]] = ()): + """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 + async def pages(self) -> AsyncIterable[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) -> AsyncIterable[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/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py new file mode 100644 index 0000000..5b18a8e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/__init__.py @@ -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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[CloudCatalogTransport]] +_transport_registry['grpc'] = CloudCatalogGrpcTransport +_transport_registry['grpc_asyncio'] = CloudCatalogGrpcAsyncIOTransport + +__all__ = ( + 'CloudCatalogTransport', + 'CloudCatalogGrpcTransport', + 'CloudCatalogGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py new file mode 100644 index 0000000..3651e80 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/base.py @@ -0,0 +1,196 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 +import packaging.version +import pkg_resources + +from google import auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore + +from google.cloud.billing_v1.types import cloud_catalog + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-billing', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + +_API_CORE_VERSION = google.api_core.__version__ + + +class CloudCatalogTransport(abc.ABC): + """Abstract transport class for CloudCatalog.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'cloudbilling.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: 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, + **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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): These two class methods are in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-api-core + # and google-auth are increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + # TODO: Remove this function once google-api-core >= 1.26.0 is required + @classmethod + def _get_self_signed_jwt_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Union[Optional[Sequence[str]], str]]: + """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" + + self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} + + if _API_CORE_VERSION and ( + packaging.version.parse(_API_CORE_VERSION) + >= packaging.version.parse("1.26.0") + ): + self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES + self_signed_jwt_kwargs["scopes"] = scopes + self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST + else: + self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES + + return self_signed_jwt_kwargs + + 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, + ), + } + + @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() + + +__all__ = ( + 'CloudCatalogTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py new file mode 100644 index 0000000..66e384d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc.py @@ -0,0 +1,281 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google import auth # type: ignore +from google.auth import 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: credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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: credentials.Credentials = None, + credentials_file: 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. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **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'] + + +__all__ = ( + 'CloudCatalogGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py new file mode 100644 index 0000000..6b00208 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/services/cloud_catalog/transports/grpc_asyncio.py @@ -0,0 +1,286 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google import auth # type: ignore +from google.auth import credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +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: 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. + """ + + self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + **self_signed_jwt_kwargs, + **kwargs + ) + + def __init__(self, *, + host: str = 'cloudbilling.googleapis.com', + credentials: credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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'] + + +__all__ = ( + 'CloudCatalogGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/billing_v1/types/__init__.py new file mode 100644 index 0000000..6d1b283 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/types/__init__.py @@ -0,0 +1,64 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, + ListServicesRequest, + ListServicesResponse, + ListSkusRequest, + ListSkusResponse, + PricingExpression, + PricingInfo, + Service, + Sku, +) + +__all__ = ( + 'BillingAccount', + 'CreateBillingAccountRequest', + 'GetBillingAccountRequest', + 'GetProjectBillingInfoRequest', + 'ListBillingAccountsRequest', + 'ListBillingAccountsResponse', + 'ListProjectBillingInfoRequest', + 'ListProjectBillingInfoResponse', + 'ProjectBillingInfo', + 'UpdateBillingAccountRequest', + 'UpdateProjectBillingInfoRequest', + 'AggregationInfo', + 'Category', + 'ListServicesRequest', + 'ListServicesResponse', + 'ListSkusRequest', + 'ListSkusResponse', + 'PricingExpression', + 'PricingInfo', + 'Service', + 'Sku', +) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_billing.py b/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_billing.py new file mode 100644 index 0000000..10fae1a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_billing.py @@ -0,0 +1,362 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 proto # type: ignore + +from google.protobuf import field_mask_pb2 as field_mask # 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 `GCP + Console `__. You can assign a + billing account to one or more projects. + + Attributes: + name (str): + 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 GCP + Console. + master_billing_account (str): + If this account is a + `subaccount `__, + then this will be the resource name of the master billing + account that it is being resold through. Otherwise this will + be empty. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + open_ = proto.Field( + proto.BOOL, + number=2, + ) + display_name = proto.Field( + proto.STRING, + number=3, + ) + master_billing_account = proto.Field( + proto.STRING, + number=4, + ) + + +class ProjectBillingInfo(proto.Message): + r"""Encapsulation of billing information for a GCP 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): + 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. + 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. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + project_id = proto.Field( + proto.STRING, + number=2, + ) + billing_account_name = proto.Field( + proto.STRING, + number=3, + ) + billing_enabled = 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 = 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 = proto.Field( + proto.INT32, + number=1, + ) + page_token = proto.Field( + proto.STRING, + number=2, + ) + filter = proto.Field( + proto.STRING, + number=3, + ) + + +class ListBillingAccountsResponse(proto.Message): + r"""Response message for ``ListBillingAccounts``. + Attributes: + billing_accounts (Sequence[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 = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='BillingAccount', + ) + next_page_token = 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 master + billing account. + """ + + billing_account = 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 = proto.Field( + proto.STRING, + number=1, + ) + account = proto.Field( + proto.MESSAGE, + number=2, + message='BillingAccount', + ) + update_mask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask.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 = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListProjectBillingInfoResponse(proto.Message): + r"""Request message for ``ListProjectBillingInfoResponse``. + Attributes: + project_billing_info (Sequence[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 = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='ProjectBillingInfo', + ) + next_page_token = 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 = 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 = proto.Field( + proto.STRING, + number=1, + ) + project_billing_info = proto.Field( + proto.MESSAGE, + number=2, + message='ProjectBillingInfo', + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_catalog.py b/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_catalog.py new file mode 100644 index 0000000..12301bd --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/billing_v1/types/cloud_catalog.py @@ -0,0 +1,522 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 proto # type: ignore + +from google.protobuf import timestamp_pb2 as timestamp # type: ignore +from google.type import money_pb2 as money # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.billing.v1', + manifest={ + 'Service', + 'Sku', + 'Category', + 'PricingInfo', + 'PricingExpression', + 'AggregationInfo', + '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 = proto.Field( + proto.STRING, + number=1, + ) + service_id = proto.Field( + proto.STRING, + number=2, + ) + display_name = proto.Field( + proto.STRING, + number=3, + ) + business_entity_name = 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 (Sequence[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 (Sequence[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. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + sku_id = proto.Field( + proto.STRING, + number=2, + ) + description = proto.Field( + proto.STRING, + number=3, + ) + category = proto.Field( + proto.MESSAGE, + number=4, + message='Category', + ) + service_regions = proto.RepeatedField( + proto.STRING, + number=5, + ) + pricing_info = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='PricingInfo', + ) + service_provider_name = proto.Field( + proto.STRING, + number=7, + ) + + +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 = proto.Field( + proto.STRING, + number=1, + ) + resource_family = proto.Field( + proto.STRING, + number=2, + ) + resource_group = proto.Field( + proto.STRING, + number=3, + ) + usage_type = 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 = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp.Timestamp, + ) + summary = proto.Field( + proto.STRING, + number=2, + ) + pricing_expression = proto.Field( + proto.MESSAGE, + number=3, + message='PricingExpression', + ) + aggregation_info = proto.Field( + proto.MESSAGE, + number=4, + message='AggregationInfo', + ) + currency_conversion_rate = 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". + 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. + 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 (Sequence[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. + """ + + 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 = proto.Field( + proto.DOUBLE, + number=1, + ) + unit_price = proto.Field( + proto.MESSAGE, + number=2, + message=money.Money, + ) + + usage_unit = proto.Field( + proto.STRING, + number=1, + ) + usage_unit_description = proto.Field( + proto.STRING, + number=4, + ) + base_unit = proto.Field( + proto.STRING, + number=5, + ) + base_unit_description = proto.Field( + proto.STRING, + number=6, + ) + base_unit_conversion_factor = proto.Field( + proto.DOUBLE, + number=7, + ) + display_quantity = proto.Field( + proto.DOUBLE, + number=2, + ) + tiered_rates = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=TierRate, + ) + + +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. + """ + 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. + """ + AGGREGATION_INTERVAL_UNSPECIFIED = 0 + DAILY = 1 + MONTHLY = 2 + + aggregation_level = proto.Field( + proto.ENUM, + number=1, + enum=AggregationLevel, + ) + aggregation_interval = proto.Field( + proto.ENUM, + number=2, + enum=AggregationInterval, + ) + aggregation_count = proto.Field( + proto.INT32, + number=3, + ) + + +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 = proto.Field( + proto.INT32, + number=1, + ) + page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class ListServicesResponse(proto.Message): + r"""Response message for ``ListServices``. + Attributes: + services (Sequence[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 = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Service', + ) + next_page_token = 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 = proto.Field( + proto.STRING, + number=1, + ) + start_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp.Timestamp, + ) + end_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp.Timestamp, + ) + currency_code = proto.Field( + proto.STRING, + number=4, + ) + page_size = proto.Field( + proto.INT32, + number=5, + ) + page_token = proto.Field( + proto.STRING, + number=6, + ) + + +class ListSkusResponse(proto.Message): + r"""Response message for ``ListSkus``. + Attributes: + skus (Sequence[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 = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Sku', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..f398dba --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,130 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 + +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") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/billing_v1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy') + 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='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_billing_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_billing_v1_keywords.py new file mode 100644 index 0000000..b55ab79 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_billing_v1_keywords.py @@ -0,0 +1,187 @@ +#! /usr/bin/env python3 +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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_', ), + '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: not a.keyword.value 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/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..c4d9cd8 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,53 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 + +version = '0.1.0' + +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() + +setuptools.setup( + name='google-cloud-billing', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.22.2, < 2.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', 'grpc-google-iam-v1 >= 0.12.3, < 0.13dev', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/billing_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py new file mode 100644 index 0000000..6dc3840 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_billing.py @@ -0,0 +1,3590 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google import auth +from google.api_core import client_options +from google.api_core import 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.auth import 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.services.cloud_billing.transports.base import _API_CORE_VERSION +from google.cloud.billing_v1.services.cloud_billing.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.billing_v1.types import cloud_billing +from google.iam.v1 import iam_policy_pb2 as iam_policy # type: ignore +from google.iam.v1 import options_pb2 as gi_options # type: ignore +from google.iam.v1 import policy_pb2 as gi_policy # type: ignore +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 as field_mask # type: ignore +from google.type import expr_pb2 as expr # type: ignore + + +# TODO(busunkim): Once google-api-core >= 1.26.0 is required: +# - Delete all the api-core and auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +requires_api_core_lt_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), + reason="This test requires google-api-core < 1.26.0", +) + +requires_api_core_gte_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), + reason="This test requires google-api-core >= 1.26.0", +) + +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", [ + CloudBillingClient, + CloudBillingAsyncClient, +]) +def test_cloud_billing_client_from_service_account_info(client_class): + creds = 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) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + CloudBillingClient, + CloudBillingAsyncClient, +]) +def test_cloud_billing_client_from_service_account_file(client_class): + creds = 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") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +def test_cloud_billing_client_get_transport_class(): + transport = CloudBillingClient.get_transport_class() + available_transports = [ + transports.CloudBillingGrpcTransport, + ] + 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"), +]) +@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=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(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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + # 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() + + # 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() + + # 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) + 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, + ) + +@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"), +]) +@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) + + 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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), +]) +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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudBillingClient, transports.CloudBillingGrpcTransport, "grpc"), + (CloudBillingAsyncClient, transports.CloudBillingGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_cloud_billing_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + 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, + ) + + +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, + ) + + +def test_get_billing_account(transport: str = 'grpc', request_type=cloud_billing.GetBillingAccountRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_get_billing_account(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].name == 'name_value' + + +def test_get_billing_account_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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', + ) + + +def test_list_billing_accounts(transport: str = 'grpc', request_type=cloud_billing.ListBillingAccountsRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_list_billing_accounts(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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(): + client = CloudBillingClient( + credentials=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__') 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 = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.BillingAccount) + for i in results) + +def test_list_billing_accounts_pages(): + client = CloudBillingClient( + credentials=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__') 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=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: + 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=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: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_update_billing_account(transport: str = 'grpc', request_type=cloud_billing.UpdateBillingAccountRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_update_billing_account(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].name == 'name_value' + assert args[0].account == cloud_billing.BillingAccount(name='name_value') + + +def test_update_billing_account_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].name == 'name_value' + assert args[0].account == cloud_billing.BillingAccount(name='name_value') + + +@pytest.mark.asyncio +async def test_update_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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'), + ) + + +def test_create_billing_account(transport: str = 'grpc', request_type=cloud_billing.CreateBillingAccountRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_create_billing_account(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=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] + assert args[0].billing_account == cloud_billing.BillingAccount(name='name_value') + + +def test_create_billing_account_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].billing_account == cloud_billing.BillingAccount(name='name_value') + + +@pytest.mark.asyncio +async def test_create_billing_account_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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'), + ) + + +def test_list_project_billing_info(transport: str = 'grpc', request_type=cloud_billing.ListProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_list_project_billing_info(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].name == 'name_value' + + +def test_list_project_billing_info_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_list_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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(): + client = CloudBillingClient( + credentials=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: + # 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 = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, cloud_billing.ProjectBillingInfo) + for i in results) + +def test_list_project_billing_info_pages(): + client = CloudBillingClient( + credentials=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: + # 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=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: + 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=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: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_project_billing_info(transport: str = 'grpc', request_type=cloud_billing.GetProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_get_project_billing_info(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].name == 'name_value' + + +def test_get_project_billing_info_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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', + ) + + +def test_update_project_billing_info(transport: str = 'grpc', request_type=cloud_billing.UpdateProjectBillingInfoRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_update_project_billing_info(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].name == 'name_value' + assert args[0].project_billing_info == cloud_billing.ProjectBillingInfo(name='name_value') + + +def test_update_project_billing_info_flattened_error(): + client = CloudBillingClient( + credentials=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=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] + assert args[0].name == 'name_value' + assert args[0].project_billing_info == cloud_billing.ProjectBillingInfo(name='name_value') + + +@pytest.mark.asyncio +async def test_update_project_billing_info_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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'), + ) + + +def test_get_iam_policy(transport: str = 'grpc', request_type=iam_policy.GetIamPolicyRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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 = gi_policy.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.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gi_policy.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_get_iam_policy_from_dict(): + test_get_iam_policy(request_type=dict) + + +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=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.GetIamPolicyRequest() + + +@pytest.mark.asyncio +async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy.GetIamPolicyRequest): + client = CloudBillingAsyncClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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(gi_policy.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.GetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gi_policy.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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 = gi_policy.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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(gi_policy.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=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 = gi_policy.Policy() + response = client.get_iam_policy(request={ + 'resource': 'resource_value', + 'options_': gi_options.GetPolicyOptions(requested_policy_version=2598), + } + ) + call.assert_called() + + +def test_get_iam_policy_flattened(): + client = CloudBillingClient( + credentials=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 = gi_policy.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] + assert args[0].resource == 'resource_value' + + +def test_get_iam_policy_flattened_error(): + client = CloudBillingClient( + credentials=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.GetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_async(): + client = CloudBillingAsyncClient( + credentials=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 = gi_policy.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gi_policy.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] + assert args[0].resource == 'resource_value' + + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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.GetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_set_iam_policy(transport: str = 'grpc', request_type=iam_policy.SetIamPolicyRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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 = gi_policy.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.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gi_policy.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_set_iam_policy_from_dict(): + test_set_iam_policy(request_type=dict) + + +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=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.SetIamPolicyRequest() + + +@pytest.mark.asyncio +async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy.SetIamPolicyRequest): + client = CloudBillingAsyncClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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(gi_policy.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.SetIamPolicyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, gi_policy.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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 = gi_policy.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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(gi_policy.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=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 = gi_policy.Policy() + response = client.set_iam_policy(request={ + 'resource': 'resource_value', + 'policy_': gi_policy.Policy(version=774), + } + ) + call.assert_called() + + +def test_set_iam_policy_flattened(): + client = CloudBillingClient( + credentials=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 = gi_policy.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] + assert args[0].resource == 'resource_value' + + +def test_set_iam_policy_flattened_error(): + client = CloudBillingClient( + credentials=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.SetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_async(): + client = CloudBillingAsyncClient( + credentials=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 = gi_policy.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gi_policy.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] + assert args[0].resource == 'resource_value' + + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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.SetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_test_iam_permissions(transport: str = 'grpc', request_type=iam_policy.TestIamPermissionsRequest): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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.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.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +def test_test_iam_permissions_from_dict(): + test_test_iam_permissions(request_type=dict) + + +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=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.TestIamPermissionsRequest() + + +@pytest.mark.asyncio +async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy.TestIamPermissionsRequest): + client = CloudBillingAsyncClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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.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.TestIamPermissionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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.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=credentials.AnonymousCredentials(), + ) + + # Any value 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.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.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=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.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=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.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] + assert args[0].resource == 'resource_value' + assert args[0].permissions == ['permissions_value'] + + +def test_test_iam_permissions_flattened_error(): + client = CloudBillingClient( + credentials=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.TestIamPermissionsRequest(), + resource='resource_value', + permissions=['permissions_value'], + ) + + +@pytest.mark.asyncio +async def test_test_iam_permissions_flattened_async(): + client = CloudBillingAsyncClient( + credentials=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.TestIamPermissionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy.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] + assert args[0].resource == 'resource_value' + assert args[0].permissions == ['permissions_value'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_flattened_error_async(): + client = CloudBillingAsyncClient( + credentials=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.TestIamPermissionsRequest(), + resource='resource_value', + permissions=['permissions_value'], + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudBillingClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CloudBillingGrpcTransport( + credentials=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=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=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CloudBillingGrpcAsyncIOTransport( + credentials=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(auth, 'default') as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = CloudBillingClient( + credentials=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(exceptions.DuplicateCredentialArgs): + transport = transports.CloudBillingTransport( + credentials=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=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()) + + +@requires_google_auth_gte_1_25_0 +def test_cloud_billing_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(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 = (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-platform', ), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_cloud_billing_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(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 = (credentials.AnonymousCredentials(), None) + transport = transports.CloudBillingTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + '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(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 = (credentials.AnonymousCredentials(), None) + transport = transports.CloudBillingTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_cloud_billing_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + CloudBillingClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_cloud_billing_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + CloudBillingClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +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(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudBillingGrpcTransport, + transports.CloudBillingGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_cloud_billing_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.CloudBillingGrpcTransport, grpc_helpers), + (transports.CloudBillingGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_gte_1_26_0 +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(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( '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,grpc_helpers", + [ + (transports.CloudBillingGrpcTransport, grpc_helpers), + (transports.CloudBillingGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_lt_1_26_0 +def test_cloud_billing_transport_create_channel_old_api_core(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus") + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.CloudBillingGrpcTransport, grpc_helpers), + (transports.CloudBillingGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_lt_1_26_0 +def test_cloud_billing_transport_create_channel_user_scopes(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=["1", "2"], + 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 = 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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_host_no_port(): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), + ) + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +def test_cloud_billing_host_with_port(): + client = CloudBillingClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), + ) + assert client.transport._host == 'cloudbilling.googleapis.com:8000' + +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 = credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_common_billing_account_path(): + billing_account = "squid" + 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": "clam", + } + 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 = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = CloudBillingClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + 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 = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = CloudBillingClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + 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 = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = CloudBillingClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + 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 = "winkle" + location = "nautilus" + 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": "scallop", + "location": "abalone", + } + 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_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.CloudBillingTransport, '_prep_wrapped_messages') as prep: + client = CloudBillingClient( + credentials=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=credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py new file mode 100644 index 0000000..18967ba --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/billing_v1/test_cloud_catalog.py @@ -0,0 +1,1693 @@ +# -*- 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google import auth +from google.api_core import client_options +from google.api_core import 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.auth import 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.services.cloud_catalog.transports.base import _API_CORE_VERSION +from google.cloud.billing_v1.services.cloud_catalog.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.billing_v1.types import cloud_catalog +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 as timestamp # type: ignore + + +# TODO(busunkim): Once google-api-core >= 1.26.0 is required: +# - Delete all the api-core and auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +requires_api_core_lt_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), + reason="This test requires google-api-core < 1.26.0", +) + +requires_api_core_gte_1_26_0 = pytest.mark.skipif( + packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), + reason="This test requires google-api-core >= 1.26.0", +) + +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", [ + CloudCatalogClient, + CloudCatalogAsyncClient, +]) +def test_cloud_catalog_client_from_service_account_info(client_class): + creds = 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) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + CloudCatalogClient, + CloudCatalogAsyncClient, +]) +def test_cloud_catalog_client_from_service_account_file(client_class): + creds = 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") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +def test_cloud_catalog_client_get_transport_class(): + transport = CloudCatalogClient.get_transport_class() + available_transports = [ + transports.CloudCatalogGrpcTransport, + ] + 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"), +]) +@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=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(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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + # 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() + + # 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() + + # 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) + 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, + ) + +@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"), +]) +@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) + + 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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), +]) +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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (CloudCatalogClient, transports.CloudCatalogGrpcTransport, "grpc"), + (CloudCatalogAsyncClient, transports.CloudCatalogGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_cloud_catalog_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + 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, + ) + + +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, + ) + + +def test_list_services(transport: str = 'grpc', request_type=cloud_catalog.ListServicesRequest): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_list_services(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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(): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials, + ) + + # 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 = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Service) + for i in results) + +def test_list_services_pages(): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials, + ) + + # 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=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: + 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=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: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_list_skus(transport: str = 'grpc', request_type=cloud_catalog.ListSkusRequest): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_from_dict(): + test_list_skus(request_type=dict) + + +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=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=credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=credentials.AnonymousCredentials(), + ) + + # Any value 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=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] + assert args[0].parent == 'parent_value' + + +def test_list_skus_flattened_error(): + client = CloudCatalogClient( + credentials=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=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] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_skus_flattened_error_async(): + client = CloudCatalogAsyncClient( + credentials=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(): + client = CloudCatalogClient( + credentials=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: + # 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 = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, cloud_catalog.Sku) + for i in results) + +def test_list_skus_pages(): + client = CloudCatalogClient( + credentials=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: + # 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=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: + 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=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: + pages.append(page_) + 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=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudCatalogClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CloudCatalogGrpcTransport( + credentials=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=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=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CloudCatalogGrpcAsyncIOTransport( + credentials=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(auth, 'default') as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = CloudCatalogClient( + credentials=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(exceptions.DuplicateCredentialArgs): + transport = transports.CloudCatalogTransport( + credentials=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=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()) + + +@requires_google_auth_gte_1_25_0 +def test_cloud_catalog_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(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 = (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-platform', ), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_cloud_catalog_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(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 = (credentials.AnonymousCredentials(), None) + transport = transports.CloudCatalogTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + '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(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 = (credentials.AnonymousCredentials(), None) + transport = transports.CloudCatalogTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_cloud_catalog_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + CloudCatalogClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_cloud_catalog_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + CloudCatalogClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +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(auth, 'default', autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudCatalogGrpcTransport, + transports.CloudCatalogGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_cloud_catalog_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.CloudCatalogGrpcTransport, grpc_helpers), + (transports.CloudCatalogGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_gte_1_26_0 +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(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( '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,grpc_helpers", + [ + (transports.CloudCatalogGrpcTransport, grpc_helpers), + (transports.CloudCatalogGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_lt_1_26_0 +def test_cloud_catalog_transport_create_channel_old_api_core(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus") + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.CloudCatalogGrpcTransport, grpc_helpers), + (transports.CloudCatalogGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +@requires_api_core_lt_1_26_0 +def test_cloud_catalog_transport_create_channel_user_scopes(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = credentials.AnonymousCredentials() + adc.return_value = (creds, None) + + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "cloudbilling.googleapis.com", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + scopes=["1", "2"], + 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 = 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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_host_no_port(): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com'), + ) + assert client.transport._host == 'cloudbilling.googleapis.com:443' + + +def test_cloud_catalog_host_with_port(): + client = CloudCatalogClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudbilling.googleapis.com:8000'), + ) + assert client.transport._host == 'cloudbilling.googleapis.com:8000' + +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 = credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.CloudCatalogTransport, '_prep_wrapped_messages') as prep: + client = CloudCatalogClient( + credentials=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=credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info)