From 337c00035f246f0d0165f3611e9c4e17dc0a0c98 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:00:28 +0000 Subject: [PATCH 1/2] fix: enable self signed jwt for grpc chore: use gapic-generator-python 0.50.5 PiperOrigin-RevId: 386504689 Source-Link: https://github.com/googleapis/googleapis/commit/762094a99ac6e03a17516b13dfbef37927267a70 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6bfc480e1a161d5de121c2bcc3745885d33b265a --- owl-bot-staging/v1/.coveragerc | 17 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 ++ owl-bot-staging/v1/docs/index.rst | 7 + .../v1/docs/recommender_v1/recommender.rst | 10 + .../v1/docs/recommender_v1/services.rst | 6 + .../v1/docs/recommender_v1/types.rst | 7 + .../v1/google/cloud/recommender/__init__.py | 63 + .../v1/google/cloud/recommender/py.typed | 2 + .../google/cloud/recommender_v1/__init__.py | 64 + .../cloud/recommender_v1/gapic_metadata.json | 103 + .../v1/google/cloud/recommender_v1/py.typed | 2 + .../cloud/recommender_v1/services/__init__.py | 15 + .../services/recommender/__init__.py | 22 + .../services/recommender/async_client.py | 993 +++++ .../services/recommender/client.py | 1179 ++++++ .../services/recommender/pagers.py | 264 ++ .../recommender/transports/__init__.py | 33 + .../services/recommender/transports/base.py | 296 ++ .../services/recommender/transports/grpc.py | 482 +++ .../recommender/transports/grpc_asyncio.py | 486 +++ .../cloud/recommender_v1/types/__init__.py | 64 + .../cloud/recommender_v1/types/insight.py | 170 + .../recommender_v1/types/recommendation.py | 420 ++ .../types/recommender_service.py | 335 ++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../scripts/fixup_recommender_v1_keywords.py | 183 + owl-bot-staging/v1/setup.py | 54 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../unit/gapic/recommender_v1/__init__.py | 16 + .../gapic/recommender_v1/test_recommender.py | 3377 +++++++++++++++++ owl-bot-staging/v1beta1/.coveragerc | 17 + owl-bot-staging/v1beta1/MANIFEST.in | 2 + owl-bot-staging/v1beta1/README.rst | 49 + owl-bot-staging/v1beta1/docs/conf.py | 376 ++ owl-bot-staging/v1beta1/docs/index.rst | 7 + .../docs/recommender_v1beta1/recommender.rst | 10 + .../docs/recommender_v1beta1/services.rst | 6 + .../docs/recommender_v1beta1/types.rst | 7 + .../google/cloud/recommender/__init__.py | 63 + .../v1beta1/google/cloud/recommender/py.typed | 2 + .../cloud/recommender_v1beta1/__init__.py | 64 + .../recommender_v1beta1/gapic_metadata.json | 103 + .../google/cloud/recommender_v1beta1/py.typed | 2 + .../recommender_v1beta1/services/__init__.py | 15 + .../services/recommender/__init__.py | 22 + .../services/recommender/async_client.py | 993 +++++ .../services/recommender/client.py | 1179 ++++++ .../services/recommender/pagers.py | 264 ++ .../recommender/transports/__init__.py | 33 + .../services/recommender/transports/base.py | 296 ++ .../services/recommender/transports/grpc.py | 482 +++ .../recommender/transports/grpc_asyncio.py | 486 +++ .../recommender_v1beta1/types/__init__.py | 64 + .../recommender_v1beta1/types/insight.py | 170 + .../types/recommendation.py | 420 ++ .../types/recommender_service.py | 335 ++ owl-bot-staging/v1beta1/mypy.ini | 3 + owl-bot-staging/v1beta1/noxfile.py | 132 + .../fixup_recommender_v1beta1_keywords.py | 183 + owl-bot-staging/v1beta1/setup.py | 54 + owl-bot-staging/v1beta1/tests/__init__.py | 16 + .../v1beta1/tests/unit/__init__.py | 16 + .../v1beta1/tests/unit/gapic/__init__.py | 16 + .../gapic/recommender_v1beta1/__init__.py | 16 + .../recommender_v1beta1/test_recommender.py | 3377 +++++++++++++++++ 70 files changed, 18560 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/recommender_v1/recommender.rst create mode 100644 owl-bot-staging/v1/docs/recommender_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/recommender_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/recommender/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py create mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/recommender_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py create mode 100644 owl-bot-staging/v1beta1/.coveragerc create mode 100644 owl-bot-staging/v1beta1/MANIFEST.in create mode 100644 owl-bot-staging/v1beta1/README.rst create mode 100644 owl-bot-staging/v1beta1/docs/conf.py create mode 100644 owl-bot-staging/v1beta1/docs/index.rst create mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst create mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst create mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py create mode 100644 owl-bot-staging/v1beta1/mypy.ini create mode 100644 owl-bot-staging/v1beta1/noxfile.py create mode 100644 owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py create mode 100644 owl-bot-staging/v1beta1/setup.py create mode 100644 owl-bot-staging/v1beta1/tests/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..cacc3bc --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/recommender/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..101ac0e --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/recommender *.py +recursive-include google/cloud/recommender_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..3728662 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Recommender 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 Recommender API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..49094fc --- /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-recommender 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-recommender" +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-recommender-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-recommender.tex", + u"google-cloud-recommender 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-recommender", + u"Google Cloud Recommender 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-recommender", + u"google-cloud-recommender Documentation", + author, + "google-cloud-recommender", + "GAPIC library for Google Cloud Recommender 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..9da75ac --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + recommender_v1/services + recommender_v1/types diff --git a/owl-bot-staging/v1/docs/recommender_v1/recommender.rst b/owl-bot-staging/v1/docs/recommender_v1/recommender.rst new file mode 100644 index 0000000..c15b52f --- /dev/null +++ b/owl-bot-staging/v1/docs/recommender_v1/recommender.rst @@ -0,0 +1,10 @@ +Recommender +----------------------------- + +.. automodule:: google.cloud.recommender_v1.services.recommender + :members: + :inherited-members: + +.. automodule:: google.cloud.recommender_v1.services.recommender.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/recommender_v1/services.rst b/owl-bot-staging/v1/docs/recommender_v1/services.rst new file mode 100644 index 0000000..d23296a --- /dev/null +++ b/owl-bot-staging/v1/docs/recommender_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Recommender v1 API +============================================ +.. toctree:: + :maxdepth: 2 + + recommender diff --git a/owl-bot-staging/v1/docs/recommender_v1/types.rst b/owl-bot-staging/v1/docs/recommender_v1/types.rst new file mode 100644 index 0000000..dd13661 --- /dev/null +++ b/owl-bot-staging/v1/docs/recommender_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Recommender v1 API +========================================= + +.. automodule:: google.cloud.recommender_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recommender/__init__.py b/owl-bot-staging/v1/google/cloud/recommender/__init__.py new file mode 100644 index 0000000..61432d2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender/__init__.py @@ -0,0 +1,63 @@ +# -*- 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.recommender_v1.services.recommender.client import RecommenderClient +from google.cloud.recommender_v1.services.recommender.async_client import RecommenderAsyncClient + +from google.cloud.recommender_v1.types.insight import Insight +from google.cloud.recommender_v1.types.insight import InsightStateInfo +from google.cloud.recommender_v1.types.recommendation import CostProjection +from google.cloud.recommender_v1.types.recommendation import Impact +from google.cloud.recommender_v1.types.recommendation import Operation +from google.cloud.recommender_v1.types.recommendation import OperationGroup +from google.cloud.recommender_v1.types.recommendation import Recommendation +from google.cloud.recommender_v1.types.recommendation import RecommendationContent +from google.cloud.recommender_v1.types.recommendation import RecommendationStateInfo +from google.cloud.recommender_v1.types.recommendation import ValueMatcher +from google.cloud.recommender_v1.types.recommender_service import GetInsightRequest +from google.cloud.recommender_v1.types.recommender_service import GetRecommendationRequest +from google.cloud.recommender_v1.types.recommender_service import ListInsightsRequest +from google.cloud.recommender_v1.types.recommender_service import ListInsightsResponse +from google.cloud.recommender_v1.types.recommender_service import ListRecommendationsRequest +from google.cloud.recommender_v1.types.recommender_service import ListRecommendationsResponse +from google.cloud.recommender_v1.types.recommender_service import MarkInsightAcceptedRequest +from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationClaimedRequest +from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationFailedRequest +from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationSucceededRequest + +__all__ = ('RecommenderClient', + 'RecommenderAsyncClient', + 'Insight', + 'InsightStateInfo', + 'CostProjection', + 'Impact', + 'Operation', + 'OperationGroup', + 'Recommendation', + 'RecommendationContent', + 'RecommendationStateInfo', + 'ValueMatcher', + 'GetInsightRequest', + 'GetRecommendationRequest', + 'ListInsightsRequest', + 'ListInsightsResponse', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'MarkInsightAcceptedRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationFailedRequest', + 'MarkRecommendationSucceededRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender/py.typed b/owl-bot-staging/v1/google/cloud/recommender/py.typed new file mode 100644 index 0000000..f9105be --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py new file mode 100644 index 0000000..8bc995e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/__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 .services.recommender import RecommenderClient +from .services.recommender import RecommenderAsyncClient + +from .types.insight import Insight +from .types.insight import InsightStateInfo +from .types.recommendation import CostProjection +from .types.recommendation import Impact +from .types.recommendation import Operation +from .types.recommendation import OperationGroup +from .types.recommendation import Recommendation +from .types.recommendation import RecommendationContent +from .types.recommendation import RecommendationStateInfo +from .types.recommendation import ValueMatcher +from .types.recommender_service import GetInsightRequest +from .types.recommender_service import GetRecommendationRequest +from .types.recommender_service import ListInsightsRequest +from .types.recommender_service import ListInsightsResponse +from .types.recommender_service import ListRecommendationsRequest +from .types.recommender_service import ListRecommendationsResponse +from .types.recommender_service import MarkInsightAcceptedRequest +from .types.recommender_service import MarkRecommendationClaimedRequest +from .types.recommender_service import MarkRecommendationFailedRequest +from .types.recommender_service import MarkRecommendationSucceededRequest + +__all__ = ( + 'RecommenderAsyncClient', +'CostProjection', +'GetInsightRequest', +'GetRecommendationRequest', +'Impact', +'Insight', +'InsightStateInfo', +'ListInsightsRequest', +'ListInsightsResponse', +'ListRecommendationsRequest', +'ListRecommendationsResponse', +'MarkInsightAcceptedRequest', +'MarkRecommendationClaimedRequest', +'MarkRecommendationFailedRequest', +'MarkRecommendationSucceededRequest', +'Operation', +'OperationGroup', +'Recommendation', +'RecommendationContent', +'RecommendationStateInfo', +'RecommenderClient', +'ValueMatcher', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json new file mode 100644 index 0000000..b1bbf08 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json @@ -0,0 +1,103 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.recommender_v1", + "protoPackage": "google.cloud.recommender.v1", + "schema": "1.0", + "services": { + "Recommender": { + "clients": { + "grpc": { + "libraryClient": "RecommenderClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + } + } + }, + "grpc-async": { + "libraryClient": "RecommenderAsyncClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed b/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed new file mode 100644 index 0000000..f9105be --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_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/recommender_v1/services/recommender/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__init__.py new file mode 100644 index 0000000..09e2c3c --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__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 RecommenderClient +from .async_client import RecommenderAsyncClient + +__all__ = ( + 'RecommenderClient', + 'RecommenderAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py new file mode 100644 index 0000000..8e40bbb --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py @@ -0,0 +1,993 @@ +# -*- 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 as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1.services.recommender import pagers +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .client import RecommenderClient + + +class RecommenderAsyncClient: + """Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + """ + + _client: RecommenderClient + + DEFAULT_ENDPOINT = RecommenderClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = RecommenderClient.DEFAULT_MTLS_ENDPOINT + + insight_path = staticmethod(RecommenderClient.insight_path) + parse_insight_path = staticmethod(RecommenderClient.parse_insight_path) + insight_type_path = staticmethod(RecommenderClient.insight_type_path) + parse_insight_type_path = staticmethod(RecommenderClient.parse_insight_type_path) + recommendation_path = staticmethod(RecommenderClient.recommendation_path) + parse_recommendation_path = staticmethod(RecommenderClient.parse_recommendation_path) + recommender_path = staticmethod(RecommenderClient.recommender_path) + parse_recommender_path = staticmethod(RecommenderClient.parse_recommender_path) + common_billing_account_path = staticmethod(RecommenderClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(RecommenderClient.parse_common_billing_account_path) + common_folder_path = staticmethod(RecommenderClient.common_folder_path) + parse_common_folder_path = staticmethod(RecommenderClient.parse_common_folder_path) + common_organization_path = staticmethod(RecommenderClient.common_organization_path) + parse_common_organization_path = staticmethod(RecommenderClient.parse_common_organization_path) + common_project_path = staticmethod(RecommenderClient.common_project_path) + parse_common_project_path = staticmethod(RecommenderClient.parse_common_project_path) + common_location_path = staticmethod(RecommenderClient.common_location_path) + parse_common_location_path = staticmethod(RecommenderClient.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: + RecommenderAsyncClient: The constructed client. + """ + return RecommenderClient.from_service_account_info.__func__(RecommenderAsyncClient, 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: + RecommenderAsyncClient: The constructed client. + """ + return RecommenderClient.from_service_account_file.__func__(RecommenderAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> RecommenderTransport: + """Returns the transport used by the client instance. + + Returns: + RecommenderTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(RecommenderClient).get_transport_class, type(RecommenderClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, RecommenderTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recommender 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, ~.RecommenderTransport]): 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 = RecommenderClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_insights(self, + request: recommender_service.ListInsightsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInsightsAsyncPager: + r"""Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Args: + request (:class:`google.cloud.recommender_v1.types.ListInsightsRequest`): + The request object. Request for the `ListInsights` + method. + parent (:class:`str`): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ + INSIGHT_TYPE_ID refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types.) + + 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.recommender_v1.services.recommender.pagers.ListInsightsAsyncPager: + Response to the ListInsights method. + + 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 = recommender_service.ListInsightsRequest(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_insights, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("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.ListInsightsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_insight(self, + request: recommender_service.GetInsightRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Args: + request (:class:`google.cloud.recommender_v1.types.GetInsightRequest`): + The request object. Request to the `GetInsight` method. + name (:class:`str`): + Required. Name of the insight. + 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.recommender_v1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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 = recommender_service.GetInsightRequest(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_insight, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def mark_insight_accepted(self, + request: recommender_service.MarkInsightAcceptedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Args: + request (:class:`google.cloud.recommender_v1.types.MarkInsightAcceptedRequest`): + The request object. Request for the + `MarkInsightAccepted` method. + name (:class:`str`): + Required. Name of the insight. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]`): + Optional. State properties user wish to include with + this state. Full replace of the current state_metadata. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the Insight. + Provides optimistic locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkInsightAcceptedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_insight_accepted, + 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_recommendations(self, + request: recommender_service.ListRecommendationsRequest = None, + *, + parent: str = None, + filter: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecommendationsAsyncPager: + r"""Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1.types.ListRecommendationsRequest`): + The request object. Request for the + `ListRecommendations` method. + parent (:class:`str`): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + filter (:class:`str`): + Filter expression to restrict the recommendations + returned. Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or + state_info.state:"FAILED" + + This corresponds to the ``filter`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.services.recommender.pagers.ListRecommendationsAsyncPager: + Response to the ListRecommendations method. + + 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, filter]) + if request is 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 = recommender_service.ListRecommendationsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if filter is not None: + request.filter = filter + + # 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_recommendations, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("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.ListRecommendationsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_recommendation(self, + request: recommender_service.GetRecommendationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1.types.GetRecommendationRequest`): + The request object. Request to the `GetRecommendation` + method. + name (:class:`str`): + Required. Name of the recommendation. + 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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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 = recommender_service.GetRecommendationRequest(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_recommendation, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def mark_recommendation_claimed(self, + request: recommender_service.MarkRecommendationClaimedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest`): + The request object. Request for the + `MarkRecommendationClaimed` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationClaimedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_claimed, + 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 mark_recommendation_succeeded(self, + request: recommender_service.MarkRecommendationSucceededRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest`): + The request object. Request for the + `MarkRecommendationSucceeded` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationSucceededRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_succeeded, + 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 mark_recommendation_failed(self, + request: recommender_service.MarkRecommendationFailedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1.types.MarkRecommendationFailedRequest`): + The request object. Request for the + `MarkRecommendationFailed` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationFailedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_failed, + 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recommender", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecommenderAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py new file mode 100644 index 0000000..a304aad --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py @@ -0,0 +1,1179 @@ +# -*- 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 as core_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 as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1.services.recommender import pagers +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import RecommenderGrpcTransport +from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport + + +class RecommenderClientMeta(type): + """Metaclass for the Recommender 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[RecommenderTransport]] + _transport_registry["grpc"] = RecommenderGrpcTransport + _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[RecommenderTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class RecommenderClient(metaclass=RecommenderClientMeta): + """Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "recommender.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: + RecommenderClient: 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: + RecommenderClient: 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) -> RecommenderTransport: + """Returns the transport used by the client instance. + + Returns: + RecommenderTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def insight_path(project: str,location: str,insight_type: str,insight: str,) -> str: + """Returns a fully-qualified insight string.""" + return "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) + + @staticmethod + def parse_insight_path(path: str) -> Dict[str,str]: + """Parses a insight path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)/insights/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def insight_type_path(project: str,location: str,insight_type: str,) -> str: + """Returns a fully-qualified insight_type string.""" + return "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) + + @staticmethod + def parse_insight_type_path(path: str) -> Dict[str,str]: + """Parses a insight_type path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def recommendation_path(project: str,location: str,recommender: str,recommendation: str,) -> str: + """Returns a fully-qualified recommendation string.""" + return "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) + + @staticmethod + def parse_recommendation_path(path: str) -> Dict[str,str]: + """Parses a recommendation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)/recommendations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def recommender_path(project: str,location: str,recommender: str,) -> str: + """Returns a fully-qualified recommender string.""" + return "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) + + @staticmethod + def parse_recommender_path(path: str) -> Dict[str,str]: + """Parses a recommender path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, RecommenderTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recommender 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, RecommenderTransport]): 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() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = 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": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = 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, RecommenderTransport): + # transport is a RecommenderTransport 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, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), + ) + + def list_insights(self, + request: recommender_service.ListInsightsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInsightsPager: + r"""Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Args: + request (google.cloud.recommender_v1.types.ListInsightsRequest): + The request object. Request for the `ListInsights` + method. + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ + INSIGHT_TYPE_ID refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types.) + + 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.recommender_v1.services.recommender.pagers.ListInsightsPager: + Response to the ListInsights method. + + 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 recommender_service.ListInsightsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.ListInsightsRequest): + request = recommender_service.ListInsightsRequest(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_insights] + + # 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.ListInsightsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_insight(self, + request: recommender_service.GetInsightRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Args: + request (google.cloud.recommender_v1.types.GetInsightRequest): + The request object. Request to the `GetInsight` method. + name (str): + Required. Name of the insight. + 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.recommender_v1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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 recommender_service.GetInsightRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.GetInsightRequest): + request = recommender_service.GetInsightRequest(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_insight] + + # 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 mark_insight_accepted(self, + request: recommender_service.MarkInsightAcceptedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Args: + request (google.cloud.recommender_v1.types.MarkInsightAcceptedRequest): + The request object. Request for the + `MarkInsightAccepted` method. + name (str): + Required. Name of the insight. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): + Optional. State properties user wish to include with + this state. Full replace of the current state_metadata. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the Insight. + Provides optimistic locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkInsightAcceptedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkInsightAcceptedRequest): + request = recommender_service.MarkInsightAcceptedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_insight_accepted] + + # 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_recommendations(self, + request: recommender_service.ListRecommendationsRequest = None, + *, + parent: str = None, + filter: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecommendationsPager: + r"""Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Args: + request (google.cloud.recommender_v1.types.ListRecommendationsRequest): + The request object. Request for the + `ListRecommendations` method. + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + filter (str): + Filter expression to restrict the recommendations + returned. Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or + state_info.state:"FAILED" + + This corresponds to the ``filter`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.services.recommender.pagers.ListRecommendationsPager: + Response to the ListRecommendations method. + + 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, filter]) + if request is 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 recommender_service.ListRecommendationsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.ListRecommendationsRequest): + request = recommender_service.ListRecommendationsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if filter is not None: + request.filter = filter + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_recommendations] + + # 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.ListRecommendationsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_recommendation(self, + request: recommender_service.GetRecommendationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Args: + request (google.cloud.recommender_v1.types.GetRecommendationRequest): + The request object. Request to the `GetRecommendation` + method. + name (str): + Required. Name of the recommendation. + 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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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 recommender_service.GetRecommendationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.GetRecommendationRequest): + request = recommender_service.GetRecommendationRequest(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_recommendation] + + # 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 mark_recommendation_claimed(self, + request: recommender_service.MarkRecommendationClaimedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest): + The request object. Request for the + `MarkRecommendationClaimed` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationClaimedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationClaimedRequest): + request = recommender_service.MarkRecommendationClaimedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_claimed] + + # 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 mark_recommendation_succeeded(self, + request: recommender_service.MarkRecommendationSucceededRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest): + The request object. Request for the + `MarkRecommendationSucceeded` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationSucceededRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationSucceededRequest): + request = recommender_service.MarkRecommendationSucceededRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_succeeded] + + # 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 mark_recommendation_failed(self, + request: recommender_service.MarkRecommendationFailedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1.types.MarkRecommendationFailedRequest): + The request object. Request for the + `MarkRecommendationFailed` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationFailedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationFailedRequest): + request = recommender_service.MarkRecommendationFailedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_failed] + + # 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recommender", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecommenderClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py new file mode 100644 index 0000000..505f260 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py @@ -0,0 +1,264 @@ +# -*- 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.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service + + +class ListInsightsPager: + """A pager for iterating through ``list_insights`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1.types.ListInsightsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``insights`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListInsights`` requests and continue to iterate + through the ``insights`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1.types.ListInsightsResponse` + 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[..., recommender_service.ListInsightsResponse], + request: recommender_service.ListInsightsRequest, + response: recommender_service.ListInsightsResponse, + *, + 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.recommender_v1.types.ListInsightsRequest): + The initial request object. + response (google.cloud.recommender_v1.types.ListInsightsResponse): + 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 = recommender_service.ListInsightsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[recommender_service.ListInsightsResponse]: + 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[insight.Insight]: + for page in self.pages: + yield from page.insights + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListInsightsAsyncPager: + """A pager for iterating through ``list_insights`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1.types.ListInsightsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``insights`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListInsights`` requests and continue to iterate + through the ``insights`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1.types.ListInsightsResponse` + 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[recommender_service.ListInsightsResponse]], + request: recommender_service.ListInsightsRequest, + response: recommender_service.ListInsightsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recommender_v1.types.ListInsightsRequest): + The initial request object. + response (google.cloud.recommender_v1.types.ListInsightsResponse): + 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 = recommender_service.ListInsightsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[recommender_service.ListInsightsResponse]: + 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[insight.Insight]: + async def async_generator(): + async for page in self.pages: + for response in page.insights: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRecommendationsPager: + """A pager for iterating through ``list_recommendations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``recommendations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRecommendations`` requests and continue to iterate + through the ``recommendations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` + 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[..., recommender_service.ListRecommendationsResponse], + request: recommender_service.ListRecommendationsRequest, + response: recommender_service.ListRecommendationsResponse, + *, + 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.recommender_v1.types.ListRecommendationsRequest): + The initial request object. + response (google.cloud.recommender_v1.types.ListRecommendationsResponse): + 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 = recommender_service.ListRecommendationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[recommender_service.ListRecommendationsResponse]: + 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[recommendation.Recommendation]: + for page in self.pages: + yield from page.recommendations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRecommendationsAsyncPager: + """A pager for iterating through ``list_recommendations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``recommendations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRecommendations`` requests and continue to iterate + through the ``recommendations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` + 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[recommender_service.ListRecommendationsResponse]], + request: recommender_service.ListRecommendationsRequest, + response: recommender_service.ListRecommendationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recommender_v1.types.ListRecommendationsRequest): + The initial request object. + response (google.cloud.recommender_v1.types.ListRecommendationsResponse): + 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 = recommender_service.ListRecommendationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[recommender_service.ListRecommendationsResponse]: + 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[recommendation.Recommendation]: + async def async_generator(): + async for page in self.pages: + for response in page.recommendations: + 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/recommender_v1/services/recommender/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/__init__.py new file mode 100644 index 0000000..18245b5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/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 RecommenderTransport +from .grpc import RecommenderGrpcTransport +from .grpc_asyncio import RecommenderGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] +_transport_registry['grpc'] = RecommenderGrpcTransport +_transport_registry['grpc_asyncio'] = RecommenderGrpcAsyncIOTransport + +__all__ = ( + 'RecommenderTransport', + 'RecommenderGrpcTransport', + 'RecommenderGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py new file mode 100644 index 0000000..c2da68d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py @@ -0,0 +1,296 @@ +# -*- 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 + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-recommender', + ).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 = google.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 + + +class RecommenderTransport(abc.ABC): + """Abstract transport class for Recommender.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'recommender.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # 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 + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is 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 + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_insights: gapic_v1.method.wrap_method( + self.list_insights, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_insight: gapic_v1.method.wrap_method( + self.get_insight, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.mark_insight_accepted: gapic_v1.method.wrap_method( + self.mark_insight_accepted, + default_timeout=60.0, + client_info=client_info, + ), + self.list_recommendations: gapic_v1.method.wrap_method( + self.list_recommendations, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_recommendation: gapic_v1.method.wrap_method( + self.get_recommendation, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_claimed: gapic_v1.method.wrap_method( + self.mark_recommendation_claimed, + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_succeeded: gapic_v1.method.wrap_method( + self.mark_recommendation_succeeded, + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_failed: gapic_v1.method.wrap_method( + self.mark_recommendation_failed, + default_timeout=60.0, + client_info=client_info, + ), + } + + @property + def list_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + Union[ + recommender_service.ListInsightsResponse, + Awaitable[recommender_service.ListInsightsResponse] + ]]: + raise NotImplementedError() + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + Union[ + insight.Insight, + Awaitable[insight.Insight] + ]]: + raise NotImplementedError() + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + Union[ + insight.Insight, + Awaitable[insight.Insight] + ]]: + raise NotImplementedError() + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + Union[ + recommender_service.ListRecommendationsResponse, + Awaitable[recommender_service.ListRecommendationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'RecommenderTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py new file mode 100644 index 0000000..844527e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py @@ -0,0 +1,482 @@ +# -*- 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 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service +from .base import RecommenderTransport, DEFAULT_CLIENT_INFO + + +class RecommenderGrpcTransport(RecommenderTransport): + """gRPC backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = 'recommender.googleapis.com', + credentials: ga_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, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + 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 = 'recommender.googleapis.com', + credentials: ga_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. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def list_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + recommender_service.ListInsightsResponse]: + r"""Return a callable for the list insights method over gRPC. + + Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Returns: + Callable[[~.ListInsightsRequest], + ~.ListInsightsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insights' not in self._stubs: + self._stubs['list_insights'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/ListInsights', + request_serializer=recommender_service.ListInsightsRequest.serialize, + response_deserializer=recommender_service.ListInsightsResponse.deserialize, + ) + return self._stubs['list_insights'] + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + insight.Insight]: + r"""Return a callable for the get insight method over gRPC. + + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Returns: + Callable[[~.GetInsightRequest], + ~.Insight]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insight' not in self._stubs: + self._stubs['get_insight'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/GetInsight', + request_serializer=recommender_service.GetInsightRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['get_insight'] + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + insight.Insight]: + r"""Return a callable for the mark insight accepted method over gRPC. + + Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Returns: + Callable[[~.MarkInsightAcceptedRequest], + ~.Insight]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_insight_accepted' not in self._stubs: + self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkInsightAccepted', + request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['mark_insight_accepted'] + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + recommender_service.ListRecommendationsResponse]: + r"""Return a callable for the list recommendations method over gRPC. + + Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Returns: + Callable[[~.ListRecommendationsRequest], + ~.ListRecommendationsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendations' not in self._stubs: + self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/ListRecommendations', + request_serializer=recommender_service.ListRecommendationsRequest.serialize, + response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, + ) + return self._stubs['list_recommendations'] + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + recommendation.Recommendation]: + r"""Return a callable for the get recommendation method over gRPC. + + Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Returns: + Callable[[~.GetRecommendationRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendation' not in self._stubs: + self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/GetRecommendation', + request_serializer=recommender_service.GetRecommendationRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['get_recommendation'] + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation claimed method over gRPC. + + Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationClaimedRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_claimed' not in self._stubs: + self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationClaimed', + request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_claimed'] + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation succeeded method over gRPC. + + Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationSucceededRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_succeeded' not in self._stubs: + self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationSucceeded', + request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_succeeded'] + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation failed method over gRPC. + + Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationFailedRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_failed' not in self._stubs: + self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationFailed', + request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_failed'] + + +__all__ = ( + 'RecommenderGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py new file mode 100644 index 0000000..91db556 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py @@ -0,0 +1,486 @@ +# -*- 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.auth import credentials as ga_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.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service +from .base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .grpc import RecommenderGrpcTransport + + +class RecommenderGrpcAsyncIOTransport(RecommenderTransport): + """gRPC AsyncIO backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = 'recommender.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'recommender.googleapis.com', + credentials: ga_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, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + 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_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + Awaitable[recommender_service.ListInsightsResponse]]: + r"""Return a callable for the list insights method over gRPC. + + Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Returns: + Callable[[~.ListInsightsRequest], + Awaitable[~.ListInsightsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insights' not in self._stubs: + self._stubs['list_insights'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/ListInsights', + request_serializer=recommender_service.ListInsightsRequest.serialize, + response_deserializer=recommender_service.ListInsightsResponse.deserialize, + ) + return self._stubs['list_insights'] + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + Awaitable[insight.Insight]]: + r"""Return a callable for the get insight method over gRPC. + + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Returns: + Callable[[~.GetInsightRequest], + Awaitable[~.Insight]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insight' not in self._stubs: + self._stubs['get_insight'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/GetInsight', + request_serializer=recommender_service.GetInsightRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['get_insight'] + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + Awaitable[insight.Insight]]: + r"""Return a callable for the mark insight accepted method over gRPC. + + Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Returns: + Callable[[~.MarkInsightAcceptedRequest], + Awaitable[~.Insight]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_insight_accepted' not in self._stubs: + self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkInsightAccepted', + request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['mark_insight_accepted'] + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + Awaitable[recommender_service.ListRecommendationsResponse]]: + r"""Return a callable for the list recommendations method over gRPC. + + Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Returns: + Callable[[~.ListRecommendationsRequest], + Awaitable[~.ListRecommendationsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendations' not in self._stubs: + self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/ListRecommendations', + request_serializer=recommender_service.ListRecommendationsRequest.serialize, + response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, + ) + return self._stubs['list_recommendations'] + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the get recommendation method over gRPC. + + Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Returns: + Callable[[~.GetRecommendationRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendation' not in self._stubs: + self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/GetRecommendation', + request_serializer=recommender_service.GetRecommendationRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['get_recommendation'] + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation claimed method over gRPC. + + Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationClaimedRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_claimed' not in self._stubs: + self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationClaimed', + request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_claimed'] + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation succeeded method over gRPC. + + Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationSucceededRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_succeeded' not in self._stubs: + self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationSucceeded', + request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_succeeded'] + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation failed method over gRPC. + + Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationFailedRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_failed' not in self._stubs: + self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1.Recommender/MarkRecommendationFailed', + request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_failed'] + + +__all__ = ( + 'RecommenderGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py new file mode 100644 index 0000000..1238196 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_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 .insight import ( + Insight, + InsightStateInfo, +) +from .recommendation import ( + CostProjection, + Impact, + Operation, + OperationGroup, + Recommendation, + RecommendationContent, + RecommendationStateInfo, + ValueMatcher, +) +from .recommender_service import ( + GetInsightRequest, + GetRecommendationRequest, + ListInsightsRequest, + ListInsightsResponse, + ListRecommendationsRequest, + ListRecommendationsResponse, + MarkInsightAcceptedRequest, + MarkRecommendationClaimedRequest, + MarkRecommendationFailedRequest, + MarkRecommendationSucceededRequest, +) + +__all__ = ( + 'Insight', + 'InsightStateInfo', + 'CostProjection', + 'Impact', + 'Operation', + 'OperationGroup', + 'Recommendation', + 'RecommendationContent', + 'RecommendationStateInfo', + 'ValueMatcher', + 'GetInsightRequest', + 'GetRecommendationRequest', + 'ListInsightsRequest', + 'ListInsightsResponse', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'MarkInsightAcceptedRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationFailedRequest', + 'MarkRecommendationSucceededRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py new file mode 100644 index 0000000..df63adb --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py @@ -0,0 +1,170 @@ +# -*- 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 duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1', + manifest={ + 'Insight', + 'InsightStateInfo', + }, +) + + +class Insight(proto.Message): + r"""An insight along with the information used to derive the + insight. The insight may have associated recomendations as well. + + Attributes: + name (str): + Name of the insight. + description (str): + Free-form human readable summary in English. + The maximum length is 500 characters. + target_resources (Sequence[str]): + Fully qualified resource names that this + insight is targeting. + insight_subtype (str): + Insight subtype. Insight content schema will + be stable for a given subtype. + content (google.protobuf.struct_pb2.Struct): + A struct of custom fields to explain the + insight. Example: "grantedPermissionsCount": + "1000". + last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): + Timestamp of the latest data used to generate + the insight. + observation_period (google.protobuf.duration_pb2.Duration): + Observation period that led to the insight. The source data + used to generate the insight ends at last_refresh_time and + begins at (last_refresh_time - observation_period). + state_info (google.cloud.recommender_v1.types.InsightStateInfo): + Information state and metadata. + category (google.cloud.recommender_v1.types.Insight.Category): + Category being targeted by the insight. + etag (str): + Fingerprint of the Insight. Provides + optimistic locking when updating states. + associated_recommendations (Sequence[google.cloud.recommender_v1.types.Insight.RecommendationReference]): + Recommendations derived from this insight. + """ + class Category(proto.Enum): + r"""Insight category.""" + CATEGORY_UNSPECIFIED = 0 + COST = 1 + SECURITY = 2 + PERFORMANCE = 3 + MANAGEABILITY = 4 + + class RecommendationReference(proto.Message): + r"""Reference to an associated recommendation. + Attributes: + recommendation (str): + Recommendation resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + """ + + recommendation = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + description = proto.Field( + proto.STRING, + number=2, + ) + target_resources = proto.RepeatedField( + proto.STRING, + number=9, + ) + insight_subtype = proto.Field( + proto.STRING, + number=10, + ) + content = proto.Field( + proto.MESSAGE, + number=3, + message=struct_pb2.Struct, + ) + last_refresh_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + observation_period = proto.Field( + proto.MESSAGE, + number=5, + message=duration_pb2.Duration, + ) + state_info = proto.Field( + proto.MESSAGE, + number=6, + message='InsightStateInfo', + ) + category = proto.Field( + proto.ENUM, + number=7, + enum=Category, + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + associated_recommendations = proto.RepeatedField( + proto.MESSAGE, + number=8, + message=RecommendationReference, + ) + + +class InsightStateInfo(proto.Message): + r"""Information related to insight state. + Attributes: + state (google.cloud.recommender_v1.types.InsightStateInfo.State): + Insight state. + state_metadata (Sequence[google.cloud.recommender_v1.types.InsightStateInfo.StateMetadataEntry]): + A map of metadata for the state, provided by + user or automations systems. + """ + class State(proto.Enum): + r"""Represents insight state.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 1 + ACCEPTED = 2 + DISMISSED = 3 + + state = proto.Field( + proto.ENUM, + number=1, + enum=State, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py new file mode 100644 index 0000000..d4a1a9a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py @@ -0,0 +1,420 @@ +# -*- 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 duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1', + manifest={ + 'Recommendation', + 'RecommendationContent', + 'OperationGroup', + 'Operation', + 'ValueMatcher', + 'CostProjection', + 'Impact', + 'RecommendationStateInfo', + }, +) + + +class Recommendation(proto.Message): + r"""A recommendation along with a suggested action. E.g., a + rightsizing recommendation for an underutilized VM, IAM role + recommendations, etc + + Attributes: + name (str): + Name of recommendation. + description (str): + Free-form human readable summary in English. + The maximum length is 500 characters. + recommender_subtype (str): + Contains an identifier for a subtype of recommendations + produced for the same recommender. Subtype is a function of + content and impact, meaning a new subtype might be added + when significant changes to ``content`` or + ``primary_impact.category`` are introduced. See the + Recommenders section to see a list of subtypes for a given + Recommender. + + Examples: For recommender = "google.iam.policy.Recommender", + recommender_subtype can be one of + "REMOVE_ROLE"/"REPLACE_ROLE". + last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): + Last time this recommendation was refreshed + by the system that created it in the first + place. + primary_impact (google.cloud.recommender_v1.types.Impact): + The primary impact that this recommendation + can have while trying to optimize for one + category. + additional_impact (Sequence[google.cloud.recommender_v1.types.Impact]): + Optional set of additional impact that this + recommendation may have when trying to optimize + for the primary category. These may be positive + or negative. + content (google.cloud.recommender_v1.types.RecommendationContent): + Content of the recommendation describing + recommended changes to resources. + state_info (google.cloud.recommender_v1.types.RecommendationStateInfo): + Information for state. Contains state and + metadata. + etag (str): + Fingerprint of the Recommendation. Provides + optimistic locking when updating states. + associated_insights (Sequence[google.cloud.recommender_v1.types.Recommendation.InsightReference]): + Insights that led to this recommendation. + """ + + class InsightReference(proto.Message): + r"""Reference to an associated insight. + Attributes: + insight (str): + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + """ + + insight = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + description = proto.Field( + proto.STRING, + number=2, + ) + recommender_subtype = proto.Field( + proto.STRING, + number=12, + ) + last_refresh_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + primary_impact = proto.Field( + proto.MESSAGE, + number=5, + message='Impact', + ) + additional_impact = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='Impact', + ) + content = proto.Field( + proto.MESSAGE, + number=7, + message='RecommendationContent', + ) + state_info = proto.Field( + proto.MESSAGE, + number=10, + message='RecommendationStateInfo', + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + associated_insights = proto.RepeatedField( + proto.MESSAGE, + number=14, + message=InsightReference, + ) + + +class RecommendationContent(proto.Message): + r"""Contains what resources are changing and how they are + changing. + + Attributes: + operation_groups (Sequence[google.cloud.recommender_v1.types.OperationGroup]): + Operations to one or more Google Cloud + resources grouped in such a way that, all + operations within one group are expected to be + performed atomically and in an order. + """ + + operation_groups = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='OperationGroup', + ) + + +class OperationGroup(proto.Message): + r"""Group of operations that need to be performed atomically. + Attributes: + operations (Sequence[google.cloud.recommender_v1.types.Operation]): + List of operations across one or more + resources that belong to this group. Loosely + based on RFC6902 and should be performed in the + order they appear. + """ + + operations = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Operation', + ) + + +class Operation(proto.Message): + r"""Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: + + - Custom filters for describing partial array patch. + - Extended path values for describing nested arrays. + - Custom fields for describing the resource for which the operation + is being described. + - Allows extension to custom operations not natively supported by + RFC6902. See https://tools.ietf.org/html/rfc6902 for details on + the original RFC. + + Attributes: + action (str): + Type of this operation. Contains one of + 'and', 'remove', 'replace', 'move', 'copy', + 'test' and custom operations. This field is + case-insensitive and always populated. + resource_type (str): + Type of GCP resource being modified/tested. + This field is always populated. Example: + cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + resource (str): + Contains the fully qualified resource name. + This field is always populated. ex: + //cloudresourcemanager.googleapis.com/projects/foo. + path (str): + Path to the target field being operated on. + If the operation is at the resource level, then + path should be "/". This field is always + populated. + source_resource (str): + Can be set with action 'copy' to copy resource configuration + across different resources of the same type. Example: A + resource clone can be done via action = 'copy', path = "/", + from = "/", source_resource = and resource_name = . This + field is empty for all other values of ``action``. + source_path (str): + Can be set with action 'copy' or 'move' to indicate the + source field within resource or source_resource, ignored if + provided for other operation types. + value (google.protobuf.struct_pb2.Value): + Value for the ``path`` field. Will be set for + actions:'add'/'replace'. Maybe set for action: 'test'. + Either this or ``value_matcher`` will be set for 'test' + operation. An exact match must be performed. + value_matcher (google.cloud.recommender_v1.types.ValueMatcher): + Can be set for action 'test' for advanced matching for the + value of 'path' field. Either this or ``value`` will be set + for 'test' operation. + path_filters (Sequence[google.cloud.recommender_v1.types.Operation.PathFiltersEntry]): + Set of filters to apply if ``path`` refers to array elements + or nested array elements in order to narrow down to a single + unique element that is being tested/modified. This is + intended to be an exact match per filter. To perform + advanced matching, use path_value_matchers. + + - Example: { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } + - Example: { "/bindings/*/role": "roles/owner" + "/bindings/*/condition" : null } + - Example: { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", + "y@example.com"] } When both path_filters and + path_value_matchers are set, an implicit AND must be + performed. + path_value_matchers (Sequence[google.cloud.recommender_v1.types.Operation.PathValueMatchersEntry]): + Similar to path_filters, this contains set of filters to + apply if ``path`` field referes to array elements. This is + meant to support value matching beyond exact match. To + perform exact match, use path_filters. When both + path_filters and path_value_matchers are set, an implicit + AND must be performed. + """ + + action = proto.Field( + proto.STRING, + number=1, + ) + resource_type = proto.Field( + proto.STRING, + number=2, + ) + resource = proto.Field( + proto.STRING, + number=3, + ) + path = proto.Field( + proto.STRING, + number=4, + ) + source_resource = proto.Field( + proto.STRING, + number=5, + ) + source_path = proto.Field( + proto.STRING, + number=6, + ) + value = proto.Field( + proto.MESSAGE, + number=7, + oneof='path_value', + message=struct_pb2.Value, + ) + value_matcher = proto.Field( + proto.MESSAGE, + number=10, + oneof='path_value', + message='ValueMatcher', + ) + path_filters = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=8, + message=struct_pb2.Value, + ) + path_value_matchers = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=11, + message='ValueMatcher', + ) + + +class ValueMatcher(proto.Message): + r"""Contains various matching options for values for a GCP + resource field. + + Attributes: + matches_pattern (str): + To be used for full regex matching. The + regular expression is using the Google RE2 + syntax + (https://github.com/google/re2/wiki/Syntax), so + to be used with RE2::FullMatch + """ + + matches_pattern = proto.Field( + proto.STRING, + number=1, + oneof='match_variant', + ) + + +class CostProjection(proto.Message): + r"""Contains metadata about how much money a recommendation can + save or incur. + + Attributes: + cost (google.type.money_pb2.Money): + An approximate projection on amount saved or + amount incurred. Negative cost units indicate + cost savings and positive cost units indicate + increase. See google.type.Money documentation + for positive/negative units. + duration (google.protobuf.duration_pb2.Duration): + Duration for which this cost applies. + """ + + cost = proto.Field( + proto.MESSAGE, + number=1, + message=money_pb2.Money, + ) + duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + +class Impact(proto.Message): + r"""Contains the impact a recommendation can have for a given + category. + + Attributes: + category (google.cloud.recommender_v1.types.Impact.Category): + Category that is being targeted. + cost_projection (google.cloud.recommender_v1.types.CostProjection): + Use with CategoryType.COST + """ + class Category(proto.Enum): + r"""The category of the impact.""" + CATEGORY_UNSPECIFIED = 0 + COST = 1 + SECURITY = 2 + PERFORMANCE = 3 + MANAGEABILITY = 4 + + category = proto.Field( + proto.ENUM, + number=1, + enum=Category, + ) + cost_projection = proto.Field( + proto.MESSAGE, + number=100, + oneof='projection', + message='CostProjection', + ) + + +class RecommendationStateInfo(proto.Message): + r"""Information for state. Contains state and metadata. + Attributes: + state (google.cloud.recommender_v1.types.RecommendationStateInfo.State): + The state of the recommendation, Eg ACTIVE, + SUCCEEDED, FAILED. + state_metadata (Sequence[google.cloud.recommender_v1.types.RecommendationStateInfo.StateMetadataEntry]): + A map of metadata for the state, provided by + user or automations systems. + """ + class State(proto.Enum): + r"""Represents Recommendation State.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 1 + CLAIMED = 6 + SUCCEEDED = 3 + FAILED = 4 + DISMISSED = 5 + + state = proto.Field( + proto.ENUM, + number=1, + enum=State, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py new file mode 100644 index 0000000..09bff83 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py @@ -0,0 +1,335 @@ +# -*- 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.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1', + manifest={ + 'ListInsightsRequest', + 'ListInsightsResponse', + 'GetInsightRequest', + 'MarkInsightAcceptedRequest', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'GetRecommendationRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationSucceededRequest', + 'MarkRecommendationFailedRequest', + }, +) + + +class ListInsightsRequest(proto.Message): + r"""Request for the ``ListInsights`` method. + Attributes: + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID + refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types.) + page_size (int): + Optional. The maximum number of results to + return from this request. Non-positive values + are ignored. If not specified, the server will + determine the number of results to return. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters must be + identical to those in the previous call. + filter (str): + Optional. Filter expression to restrict the insights + returned. Supported filter fields: state Eg: + \`state:"DISMISSED" or state:"ACTIVE". + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + + +class ListInsightsResponse(proto.Message): + r"""Response to the ``ListInsights`` method. + Attributes: + insights (Sequence[google.cloud.recommender_v1.types.Insight]): + The set of insights for the ``parent`` resource. + next_page_token (str): + A token that can be used to request the next + page of results. This field is empty if there + are no additional results. + """ + + @property + def raw_page(self): + return self + + insights = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=insight.Insight, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetInsightRequest(proto.Message): + r"""Request to the ``GetInsight`` method. + Attributes: + name (str): + Required. Name of the insight. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class MarkInsightAcceptedRequest(proto.Message): + r"""Request for the ``MarkInsightAccepted`` method. + Attributes: + name (str): + Required. Name of the insight. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): + Optional. State properties user wish to include with this + state. Full replace of the current state_metadata. + etag (str): + Required. Fingerprint of the Insight. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class ListRecommendationsRequest(proto.Message): + r"""Request for the ``ListRecommendations`` method. + Attributes: + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + page_size (int): + Optional. The maximum number of results to + return from this request. Non-positive values + are ignored. If not specified, the server will + determine the number of results to return. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters must be + identical to those in the previous call. + filter (str): + Filter expression to restrict the recommendations returned. + Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or state_info.state:"FAILED". + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=5, + ) + + +class ListRecommendationsResponse(proto.Message): + r"""Response to the ``ListRecommendations`` method. + Attributes: + recommendations (Sequence[google.cloud.recommender_v1.types.Recommendation]): + The set of recommendations for the ``parent`` resource. + next_page_token (str): + A token that can be used to request the next + page of results. This field is empty if there + are no additional results. + """ + + @property + def raw_page(self): + return self + + recommendations = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=recommendation.Recommendation, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRecommendationRequest(proto.Message): + r"""Request to the ``GetRecommendation`` method. + Attributes: + name (str): + Required. Name of the recommendation. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class MarkRecommendationClaimedRequest(proto.Message): + r"""Request for the ``MarkRecommendationClaimed`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class MarkRecommendationSucceededRequest(proto.Message): + r"""Request for the ``MarkRecommendationSucceeded`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class MarkRecommendationFailedRequest(proto.Message): + r"""Request for the ``MarkRecommendationFailed`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +__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..7f2d2b5 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,132 @@ +# -*- 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/recommender_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', 'types-pkg_resources') + 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_recommender_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py new file mode 100644 index 0000000..c0fe445 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py @@ -0,0 +1,183 @@ +#! /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 recommenderCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'get_insight': ('name', ), + 'get_recommendation': ('name', ), + 'list_insights': ('parent', 'page_size', 'page_token', 'filter', ), + 'list_recommendations': ('parent', 'page_size', 'page_token', 'filter', ), + 'mark_insight_accepted': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_claimed': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_failed': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_succeeded': ('name', 'etag', 'state_metadata', ), + } + + 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=recommenderCallTransformer(), +): + """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 recommender 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..fc7260d --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,54 @@ +# -*- 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-recommender', + 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.27.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + 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', + 'Programming Language :: Python :: 3.9', + '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/recommender_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recommender_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/recommender_v1/test_recommender.py b/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py new file mode 100644 index 0000000..019c8f1 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py @@ -0,0 +1,3377 @@ +# -*- 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.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.recommender_v1.services.recommender import RecommenderAsyncClient +from google.cloud.recommender_v1.services.recommender import RecommenderClient +from google.cloud.recommender_v1.services.recommender import pagers +from google.cloud.recommender_v1.services.recommender import transports +from google.cloud.recommender_v1.services.recommender.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_service +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the 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", +) + +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 RecommenderClient._get_default_mtls_endpoint(None) is None + assert RecommenderClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + RecommenderClient, + RecommenderAsyncClient, +]) +def test_recommender_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'recommender.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.RecommenderGrpcTransport, "grpc"), + (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + RecommenderClient, + RecommenderAsyncClient, +]) +def test_recommender_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + 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 == 'recommender.googleapis.com:443' + + +def test_recommender_client_get_transport_class(): + transport = RecommenderClient.get_transport_class() + available_transports = [ + transports.RecommenderGrpcTransport, + ] + assert transport in available_transports + + transport = RecommenderClient.get_transport_class("grpc") + assert transport == transports.RecommenderGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) +@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) +def test_recommender_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(RecommenderClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(RecommenderClient, '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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "true"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "false"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) +@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_recommender_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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_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, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_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, + always_use_jwt_access=True, + ) + + +def test_recommender_client_client_options_from_dict(): + with mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = RecommenderClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_list_insights(transport: str = 'grpc', request_type=recommender_service.ListInsightsRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_insights(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_insights_from_dict(): + test_list_insights(request_type=dict) + + +def test_list_insights_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + client.list_insights() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + +@pytest.mark.asyncio +async def test_list_insights_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListInsightsRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_insights(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_insights_async_from_dict(): + await test_list_insights_async(request_type=dict) + + +def test_list_insights_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListInsightsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + call.return_value = recommender_service.ListInsightsResponse() + client.list_insights(request) + + # Establish that the 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_insights_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListInsightsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) + await client.list_insights(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_insights_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_insights( + 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_insights_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_insights( + recommender_service.ListInsightsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_insights_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_insights( + 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_insights_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_insights( + recommender_service.ListInsightsRequest(), + parent='parent_value', + ) + + +def test_list_insights_pager(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_insights(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, insight.Insight) + for i in results) + +def test_list_insights_pages(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + pages = list(client.list_insights(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_insights_async_pager(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_insights(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, insight.Insight) + for i in responses) + +@pytest.mark.asyncio +async def test_list_insights_async_pages(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_insights(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_insight(transport: str = 'grpc', request_type=recommender_service.GetInsightRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + ) + response = client.get_insight(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +def test_get_insight_from_dict(): + test_get_insight(request_type=dict) + + +def test_get_insight_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + client.get_insight() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + +@pytest.mark.asyncio +async def test_get_insight_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetInsightRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + )) + response = await client.get_insight(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_insight_async_from_dict(): + await test_get_insight_async(request_type=dict) + + +def test_get_insight_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetInsightRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + call.return_value = insight.Insight() + client.get_insight(request) + + # Establish that the 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_insight_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetInsightRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + await client.get_insight(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_insight_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_insight( + 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_insight_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_insight( + recommender_service.GetInsightRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_insight_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_insight( + 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_insight_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_insight( + recommender_service.GetInsightRequest(), + name='name_value', + ) + + +def test_mark_insight_accepted(transport: str = 'grpc', request_type=recommender_service.MarkInsightAcceptedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + ) + response = client.mark_insight_accepted(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +def test_mark_insight_accepted_from_dict(): + test_mark_insight_accepted(request_type=dict) + + +def test_mark_insight_accepted_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + client.mark_insight_accepted() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkInsightAcceptedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + )) + response = await client.mark_insight_accepted(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_async_from_dict(): + await test_mark_insight_accepted_async(request_type=dict) + + +def test_mark_insight_accepted_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkInsightAcceptedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + call.return_value = insight.Insight() + client.mark_insight_accepted(request) + + # Establish that the 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_mark_insight_accepted_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkInsightAcceptedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + await client.mark_insight_accepted(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_mark_insight_accepted_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_insight_accepted( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_insight_accepted_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_insight_accepted( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_list_recommendations(transport: str = 'grpc', request_type=recommender_service.ListRecommendationsRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_recommendations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_recommendations_from_dict(): + test_list_recommendations(request_type=dict) + + +def test_list_recommendations_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + client.list_recommendations() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + +@pytest.mark.asyncio +async def test_list_recommendations_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListRecommendationsRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_recommendations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_recommendations_async_from_dict(): + await test_list_recommendations_async(request_type=dict) + + +def test_list_recommendations_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListRecommendationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + call.return_value = recommender_service.ListRecommendationsResponse() + client.list_recommendations(request) + + # Establish that the 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_recommendations_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListRecommendationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) + await client.list_recommendations(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_recommendations_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_recommendations( + parent='parent_value', + filter='filter_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' + assert args[0].filter == 'filter_value' + + +def test_list_recommendations_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_recommendations( + recommender_service.ListRecommendationsRequest(), + parent='parent_value', + filter='filter_value', + ) + + +@pytest.mark.asyncio +async def test_list_recommendations_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_recommendations( + parent='parent_value', + filter='filter_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' + assert args[0].filter == 'filter_value' + + +@pytest.mark.asyncio +async def test_list_recommendations_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_recommendations( + recommender_service.ListRecommendationsRequest(), + parent='parent_value', + filter='filter_value', + ) + + +def test_list_recommendations_pager(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_recommendations(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, recommendation.Recommendation) + for i in results) + +def test_list_recommendations_pages(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + pages = list(client.list_recommendations(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_recommendations_async_pager(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_recommendations(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, recommendation.Recommendation) + for i in responses) + +@pytest.mark.asyncio +async def test_list_recommendations_async_pages(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_recommendations(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_recommendation(transport: str = 'grpc', request_type=recommender_service.GetRecommendationRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.get_recommendation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_get_recommendation_from_dict(): + test_get_recommendation(request_type=dict) + + +def test_get_recommendation_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + client.get_recommendation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + +@pytest.mark.asyncio +async def test_get_recommendation_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetRecommendationRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.get_recommendation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_recommendation_async_from_dict(): + await test_get_recommendation_async(request_type=dict) + + +def test_get_recommendation_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetRecommendationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.get_recommendation(request) + + # Establish that the 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_recommendation_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetRecommendationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.get_recommendation(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_recommendation_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_recommendation( + 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_recommendation_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_recommendation( + recommender_service.GetRecommendationRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_recommendation_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_recommendation( + 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_recommendation_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_recommendation( + recommender_service.GetRecommendationRequest(), + name='name_value', + ) + + +def test_mark_recommendation_claimed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationClaimedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_claimed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_claimed_from_dict(): + test_mark_recommendation_claimed(request_type=dict) + + +def test_mark_recommendation_claimed_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + client.mark_recommendation_claimed() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationClaimedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_claimed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_async_from_dict(): + await test_mark_recommendation_claimed_async(request_type=dict) + + +def test_mark_recommendation_claimed_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationClaimedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_claimed(request) + + # Establish that the 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_mark_recommendation_claimed_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationClaimedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_claimed(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_mark_recommendation_claimed_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_claimed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_claimed_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_claimed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_mark_recommendation_succeeded(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationSucceededRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_succeeded(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_succeeded_from_dict(): + test_mark_recommendation_succeeded(request_type=dict) + + +def test_mark_recommendation_succeeded_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + client.mark_recommendation_succeeded() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationSucceededRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_succeeded(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_async_from_dict(): + await test_mark_recommendation_succeeded_async(request_type=dict) + + +def test_mark_recommendation_succeeded_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationSucceededRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_succeeded(request) + + # Establish that the 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_mark_recommendation_succeeded_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationSucceededRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_succeeded(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_mark_recommendation_succeeded_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_succeeded( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_succeeded_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_succeeded( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_mark_recommendation_failed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationFailedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_failed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_failed_from_dict(): + test_mark_recommendation_failed(request_type=dict) + + +def test_mark_recommendation_failed_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + client.mark_recommendation_failed() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationFailedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_failed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_async_from_dict(): + await test_mark_recommendation_failed_async(request_type=dict) + + +def test_mark_recommendation_failed_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationFailedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_failed(request) + + # Establish that the 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_mark_recommendation_failed_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationFailedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_failed(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_mark_recommendation_failed_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_failed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_failed_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_failed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecommenderClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecommenderGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecommenderGrpcTransport, + ) + +def test_recommender_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_recommender_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_insights', + 'get_insight', + 'mark_insight_accepted', + 'list_recommendations', + 'get_recommendation', + 'mark_recommendation_claimed', + 'mark_recommendation_succeeded', + 'mark_recommendation_failed', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_recommender_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport( + 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_recommender_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport( + 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_recommender_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_recommender_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecommenderClient() + 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_recommender_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecommenderClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_recommender_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_recommender_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(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_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.RecommenderGrpcTransport, grpc_helpers), + (transports.RecommenderGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_recommender_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "recommender.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="recommender.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_recommender_host_no_port(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com'), + ) + assert client.transport._host == 'recommender.googleapis.com:443' + + +def test_recommender_host_with_port(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com:8000'), + ) + assert client.transport._host == 'recommender.googleapis.com:8000' + +def test_recommender_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecommenderGrpcTransport( + 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_recommender_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecommenderGrpcAsyncIOTransport( + 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.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_insight_path(): + project = "squid" + location = "clam" + insight_type = "whelk" + insight = "octopus" + expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) + actual = RecommenderClient.insight_path(project, location, insight_type, insight) + assert expected == actual + + +def test_parse_insight_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "insight_type": "cuttlefish", + "insight": "mussel", + } + path = RecommenderClient.insight_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_insight_path(path) + assert expected == actual + +def test_insight_type_path(): + project = "winkle" + location = "nautilus" + insight_type = "scallop" + expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) + actual = RecommenderClient.insight_type_path(project, location, insight_type) + assert expected == actual + + +def test_parse_insight_type_path(): + expected = { + "project": "abalone", + "location": "squid", + "insight_type": "clam", + } + path = RecommenderClient.insight_type_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_insight_type_path(path) + assert expected == actual + +def test_recommendation_path(): + project = "whelk" + location = "octopus" + recommender = "oyster" + recommendation = "nudibranch" + expected = "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) + actual = RecommenderClient.recommendation_path(project, location, recommender, recommendation) + assert expected == actual + + +def test_parse_recommendation_path(): + expected = { + "project": "cuttlefish", + "location": "mussel", + "recommender": "winkle", + "recommendation": "nautilus", + } + path = RecommenderClient.recommendation_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_recommendation_path(path) + assert expected == actual + +def test_recommender_path(): + project = "scallop" + location = "abalone" + recommender = "squid" + expected = "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) + actual = RecommenderClient.recommender_path(project, location, recommender) + assert expected == actual + + +def test_parse_recommender_path(): + expected = { + "project": "clam", + "location": "whelk", + "recommender": "octopus", + } + path = RecommenderClient.recommender_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_recommender_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = RecommenderClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = RecommenderClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format(folder=folder, ) + actual = RecommenderClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = RecommenderClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format(organization=organization, ) + actual = RecommenderClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = RecommenderClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format(project=project, ) + actual = RecommenderClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = RecommenderClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = RecommenderClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = RecommenderClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.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.RecommenderTransport, '_prep_wrapped_messages') as prep: + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.RecommenderTransport, '_prep_wrapped_messages') as prep: + transport_class = RecommenderClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1beta1/.coveragerc b/owl-bot-staging/v1beta1/.coveragerc new file mode 100644 index 0000000..cacc3bc --- /dev/null +++ b/owl-bot-staging/v1beta1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/recommender/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1beta1/MANIFEST.in b/owl-bot-staging/v1beta1/MANIFEST.in new file mode 100644 index 0000000..6eb35c3 --- /dev/null +++ b/owl-bot-staging/v1beta1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/recommender *.py +recursive-include google/cloud/recommender_v1beta1 *.py diff --git a/owl-bot-staging/v1beta1/README.rst b/owl-bot-staging/v1beta1/README.rst new file mode 100644 index 0000000..3728662 --- /dev/null +++ b/owl-bot-staging/v1beta1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Recommender 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 Recommender API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1beta1/docs/conf.py b/owl-bot-staging/v1beta1/docs/conf.py new file mode 100644 index 0000000..49094fc --- /dev/null +++ b/owl-bot-staging/v1beta1/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-recommender 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-recommender" +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-recommender-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-recommender.tex", + u"google-cloud-recommender 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-recommender", + u"Google Cloud Recommender 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-recommender", + u"google-cloud-recommender Documentation", + author, + "google-cloud-recommender", + "GAPIC library for Google Cloud Recommender API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1beta1/docs/index.rst b/owl-bot-staging/v1beta1/docs/index.rst new file mode 100644 index 0000000..ae8ca96 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + recommender_v1beta1/services + recommender_v1beta1/types diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst new file mode 100644 index 0000000..5e69281 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst @@ -0,0 +1,10 @@ +Recommender +----------------------------- + +.. automodule:: google.cloud.recommender_v1beta1.services.recommender + :members: + :inherited-members: + +.. automodule:: google.cloud.recommender_v1beta1.services.recommender.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst new file mode 100644 index 0000000..5341142 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Recommender v1beta1 API +================================================= +.. toctree:: + :maxdepth: 2 + + recommender diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst new file mode 100644 index 0000000..16ab2a8 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Recommender v1beta1 API +============================================== + +.. automodule:: google.cloud.recommender_v1beta1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py new file mode 100644 index 0000000..eacd933 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py @@ -0,0 +1,63 @@ +# -*- 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.recommender_v1beta1.services.recommender.client import RecommenderClient +from google.cloud.recommender_v1beta1.services.recommender.async_client import RecommenderAsyncClient + +from google.cloud.recommender_v1beta1.types.insight import Insight +from google.cloud.recommender_v1beta1.types.insight import InsightStateInfo +from google.cloud.recommender_v1beta1.types.recommendation import CostProjection +from google.cloud.recommender_v1beta1.types.recommendation import Impact +from google.cloud.recommender_v1beta1.types.recommendation import Operation +from google.cloud.recommender_v1beta1.types.recommendation import OperationGroup +from google.cloud.recommender_v1beta1.types.recommendation import Recommendation +from google.cloud.recommender_v1beta1.types.recommendation import RecommendationContent +from google.cloud.recommender_v1beta1.types.recommendation import RecommendationStateInfo +from google.cloud.recommender_v1beta1.types.recommendation import ValueMatcher +from google.cloud.recommender_v1beta1.types.recommender_service import GetInsightRequest +from google.cloud.recommender_v1beta1.types.recommender_service import GetRecommendationRequest +from google.cloud.recommender_v1beta1.types.recommender_service import ListInsightsRequest +from google.cloud.recommender_v1beta1.types.recommender_service import ListInsightsResponse +from google.cloud.recommender_v1beta1.types.recommender_service import ListRecommendationsRequest +from google.cloud.recommender_v1beta1.types.recommender_service import ListRecommendationsResponse +from google.cloud.recommender_v1beta1.types.recommender_service import MarkInsightAcceptedRequest +from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationClaimedRequest +from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationFailedRequest +from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationSucceededRequest + +__all__ = ('RecommenderClient', + 'RecommenderAsyncClient', + 'Insight', + 'InsightStateInfo', + 'CostProjection', + 'Impact', + 'Operation', + 'OperationGroup', + 'Recommendation', + 'RecommendationContent', + 'RecommendationStateInfo', + 'ValueMatcher', + 'GetInsightRequest', + 'GetRecommendationRequest', + 'ListInsightsRequest', + 'ListInsightsResponse', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'MarkInsightAcceptedRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationFailedRequest', + 'MarkRecommendationSucceededRequest', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed b/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed new file mode 100644 index 0000000..f9105be --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py new file mode 100644 index 0000000..8bc995e --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__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 .services.recommender import RecommenderClient +from .services.recommender import RecommenderAsyncClient + +from .types.insight import Insight +from .types.insight import InsightStateInfo +from .types.recommendation import CostProjection +from .types.recommendation import Impact +from .types.recommendation import Operation +from .types.recommendation import OperationGroup +from .types.recommendation import Recommendation +from .types.recommendation import RecommendationContent +from .types.recommendation import RecommendationStateInfo +from .types.recommendation import ValueMatcher +from .types.recommender_service import GetInsightRequest +from .types.recommender_service import GetRecommendationRequest +from .types.recommender_service import ListInsightsRequest +from .types.recommender_service import ListInsightsResponse +from .types.recommender_service import ListRecommendationsRequest +from .types.recommender_service import ListRecommendationsResponse +from .types.recommender_service import MarkInsightAcceptedRequest +from .types.recommender_service import MarkRecommendationClaimedRequest +from .types.recommender_service import MarkRecommendationFailedRequest +from .types.recommender_service import MarkRecommendationSucceededRequest + +__all__ = ( + 'RecommenderAsyncClient', +'CostProjection', +'GetInsightRequest', +'GetRecommendationRequest', +'Impact', +'Insight', +'InsightStateInfo', +'ListInsightsRequest', +'ListInsightsResponse', +'ListRecommendationsRequest', +'ListRecommendationsResponse', +'MarkInsightAcceptedRequest', +'MarkRecommendationClaimedRequest', +'MarkRecommendationFailedRequest', +'MarkRecommendationSucceededRequest', +'Operation', +'OperationGroup', +'Recommendation', +'RecommendationContent', +'RecommendationStateInfo', +'RecommenderClient', +'ValueMatcher', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json new file mode 100644 index 0000000..02139b9 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json @@ -0,0 +1,103 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.recommender_v1beta1", + "protoPackage": "google.cloud.recommender.v1beta1", + "schema": "1.0", + "services": { + "Recommender": { + "clients": { + "grpc": { + "libraryClient": "RecommenderClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + } + } + }, + "grpc-async": { + "libraryClient": "RecommenderAsyncClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed new file mode 100644 index 0000000..f9105be --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/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/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py new file mode 100644 index 0000000..09e2c3c --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__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 RecommenderClient +from .async_client import RecommenderAsyncClient + +__all__ = ( + 'RecommenderClient', + 'RecommenderAsyncClient', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py new file mode 100644 index 0000000..4933323 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py @@ -0,0 +1,993 @@ +# -*- 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 as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1beta1.services.recommender import pagers +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .client import RecommenderClient + + +class RecommenderAsyncClient: + """Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + """ + + _client: RecommenderClient + + DEFAULT_ENDPOINT = RecommenderClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = RecommenderClient.DEFAULT_MTLS_ENDPOINT + + insight_path = staticmethod(RecommenderClient.insight_path) + parse_insight_path = staticmethod(RecommenderClient.parse_insight_path) + insight_type_path = staticmethod(RecommenderClient.insight_type_path) + parse_insight_type_path = staticmethod(RecommenderClient.parse_insight_type_path) + recommendation_path = staticmethod(RecommenderClient.recommendation_path) + parse_recommendation_path = staticmethod(RecommenderClient.parse_recommendation_path) + recommender_path = staticmethod(RecommenderClient.recommender_path) + parse_recommender_path = staticmethod(RecommenderClient.parse_recommender_path) + common_billing_account_path = staticmethod(RecommenderClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(RecommenderClient.parse_common_billing_account_path) + common_folder_path = staticmethod(RecommenderClient.common_folder_path) + parse_common_folder_path = staticmethod(RecommenderClient.parse_common_folder_path) + common_organization_path = staticmethod(RecommenderClient.common_organization_path) + parse_common_organization_path = staticmethod(RecommenderClient.parse_common_organization_path) + common_project_path = staticmethod(RecommenderClient.common_project_path) + parse_common_project_path = staticmethod(RecommenderClient.parse_common_project_path) + common_location_path = staticmethod(RecommenderClient.common_location_path) + parse_common_location_path = staticmethod(RecommenderClient.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: + RecommenderAsyncClient: The constructed client. + """ + return RecommenderClient.from_service_account_info.__func__(RecommenderAsyncClient, 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: + RecommenderAsyncClient: The constructed client. + """ + return RecommenderClient.from_service_account_file.__func__(RecommenderAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> RecommenderTransport: + """Returns the transport used by the client instance. + + Returns: + RecommenderTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(RecommenderClient).get_transport_class, type(RecommenderClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, RecommenderTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recommender 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, ~.RecommenderTransport]): 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 = RecommenderClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_insights(self, + request: recommender_service.ListInsightsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInsightsAsyncPager: + r"""Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.ListInsightsRequest`): + The request object. Request for the `ListInsights` + method. + parent (:class:`str`): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ + INSIGHT_TYPE_ID refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types. + + 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.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager: + Response to the ListInsights method. + + 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 = recommender_service.ListInsightsRequest(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_insights, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("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.ListInsightsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_insight(self, + request: recommender_service.GetInsightRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.GetInsightRequest`): + The request object. Request to the `GetInsight` method. + name (:class:`str`): + Required. Name of the insight. + 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.recommender_v1beta1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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 = recommender_service.GetInsightRequest(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_insight, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def mark_insight_accepted(self, + request: recommender_service.MarkInsightAcceptedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest`): + The request object. Request for the + `MarkInsightAccepted` method. + name (:class:`str`): + Required. Name of the insight. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]`): + Optional. State properties user wish to include with + this state. Full replace of the current state_metadata. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the Insight. + Provides optimistic locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkInsightAcceptedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_insight_accepted, + 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_recommendations(self, + request: recommender_service.ListRecommendationsRequest = None, + *, + parent: str = None, + filter: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecommendationsAsyncPager: + r"""Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.ListRecommendationsRequest`): + The request object. Request for the + `ListRecommendations` method. + parent (:class:`str`): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + filter (:class:`str`): + Filter expression to restrict the recommendations + returned. Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or + state_info.state:"FAILED" + + This corresponds to the ``filter`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager: + Response to the ListRecommendations method. + + 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, filter]) + if request is 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 = recommender_service.ListRecommendationsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if filter is not None: + request.filter = filter + + # 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_recommendations, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("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.ListRecommendationsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_recommendation(self, + request: recommender_service.GetRecommendationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.GetRecommendationRequest`): + The request object. Request to the `GetRecommendation` + method. + name (:class:`str`): + Required. Name of the recommendation. + 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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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 = recommender_service.GetRecommendationRequest(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_recommendation, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def mark_recommendation_claimed(self, + request: recommender_service.MarkRecommendationClaimedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest`): + The request object. Request for the + `MarkRecommendationClaimed` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationClaimedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_claimed, + 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 mark_recommendation_succeeded(self, + request: recommender_service.MarkRecommendationSucceededRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest`): + The request object. Request for the + `MarkRecommendationSucceeded` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationSucceededRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_succeeded, + 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 mark_recommendation_failed(self, + request: recommender_service.MarkRecommendationFailedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest`): + The request object. Request for the + `MarkRecommendationFailed` Method. + name (:class:`str`): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]`): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (:class:`str`): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 = recommender_service.MarkRecommendationFailedRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if etag is not None: + request.etag = etag + + if state_metadata: + request.state_metadata.update(state_metadata) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.mark_recommendation_failed, + 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recommender", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecommenderAsyncClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py new file mode 100644 index 0000000..fdbcc02 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py @@ -0,0 +1,1179 @@ +# -*- 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 as core_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 as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1beta1.services.recommender import pagers +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import RecommenderGrpcTransport +from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport + + +class RecommenderClientMeta(type): + """Metaclass for the Recommender 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[RecommenderTransport]] + _transport_registry["grpc"] = RecommenderGrpcTransport + _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[RecommenderTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class RecommenderClient(metaclass=RecommenderClientMeta): + """Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "recommender.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: + RecommenderClient: 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: + RecommenderClient: 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) -> RecommenderTransport: + """Returns the transport used by the client instance. + + Returns: + RecommenderTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def insight_path(project: str,location: str,insight_type: str,insight: str,) -> str: + """Returns a fully-qualified insight string.""" + return "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) + + @staticmethod + def parse_insight_path(path: str) -> Dict[str,str]: + """Parses a insight path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)/insights/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def insight_type_path(project: str,location: str,insight_type: str,) -> str: + """Returns a fully-qualified insight_type string.""" + return "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) + + @staticmethod + def parse_insight_type_path(path: str) -> Dict[str,str]: + """Parses a insight_type path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def recommendation_path(project: str,location: str,recommender: str,recommendation: str,) -> str: + """Returns a fully-qualified recommendation string.""" + return "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) + + @staticmethod + def parse_recommendation_path(path: str) -> Dict[str,str]: + """Parses a recommendation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)/recommendations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def recommender_path(project: str,location: str,recommender: str,) -> str: + """Returns a fully-qualified recommender string.""" + return "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) + + @staticmethod + def parse_recommender_path(path: str) -> Dict[str,str]: + """Parses a recommender path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, RecommenderTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recommender 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, RecommenderTransport]): 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() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = 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": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = 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, RecommenderTransport): + # transport is a RecommenderTransport 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, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), + ) + + def list_insights(self, + request: recommender_service.ListInsightsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListInsightsPager: + r"""Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Args: + request (google.cloud.recommender_v1beta1.types.ListInsightsRequest): + The request object. Request for the `ListInsights` + method. + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ + INSIGHT_TYPE_ID refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types. + + 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.recommender_v1beta1.services.recommender.pagers.ListInsightsPager: + Response to the ListInsights method. + + 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 recommender_service.ListInsightsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.ListInsightsRequest): + request = recommender_service.ListInsightsRequest(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_insights] + + # 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.ListInsightsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_insight(self, + request: recommender_service.GetInsightRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Args: + request (google.cloud.recommender_v1beta1.types.GetInsightRequest): + The request object. Request to the `GetInsight` method. + name (str): + Required. Name of the insight. + 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.recommender_v1beta1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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 recommender_service.GetInsightRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.GetInsightRequest): + request = recommender_service.GetInsightRequest(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_insight] + + # 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 mark_insight_accepted(self, + request: recommender_service.MarkInsightAcceptedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Args: + request (google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest): + The request object. Request for the + `MarkInsightAccepted` method. + name (str): + Required. Name of the insight. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): + Optional. State properties user wish to include with + this state. Full replace of the current state_metadata. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the Insight. + Provides optimistic locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkInsightAcceptedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkInsightAcceptedRequest): + request = recommender_service.MarkInsightAcceptedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_insight_accepted] + + # 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_recommendations(self, + request: recommender_service.ListRecommendationsRequest = None, + *, + parent: str = None, + filter: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecommendationsPager: + r"""Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Args: + request (google.cloud.recommender_v1beta1.types.ListRecommendationsRequest): + The request object. Request for the + `ListRecommendations` method. + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + filter (str): + Filter expression to restrict the recommendations + returned. Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or + state_info.state:"FAILED" + + This corresponds to the ``filter`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.services.recommender.pagers.ListRecommendationsPager: + Response to the ListRecommendations method. + + 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, filter]) + if request is 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 recommender_service.ListRecommendationsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.ListRecommendationsRequest): + request = recommender_service.ListRecommendationsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if filter is not None: + request.filter = filter + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_recommendations] + + # 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.ListRecommendationsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_recommendation(self, + request: recommender_service.GetRecommendationRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Args: + request (google.cloud.recommender_v1beta1.types.GetRecommendationRequest): + The request object. Request to the `GetRecommendation` + method. + name (str): + Required. Name of the recommendation. + 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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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 recommender_service.GetRecommendationRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.GetRecommendationRequest): + request = recommender_service.GetRecommendationRequest(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_recommendation] + + # 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 mark_recommendation_claimed(self, + request: recommender_service.MarkRecommendationClaimedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest): + The request object. Request for the + `MarkRecommendationClaimed` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationClaimedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationClaimedRequest): + request = recommender_service.MarkRecommendationClaimedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_claimed] + + # 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 mark_recommendation_succeeded(self, + request: recommender_service.MarkRecommendationSucceededRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest): + The request object. Request for the + `MarkRecommendationSucceeded` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationSucceededRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationSucceededRequest): + request = recommender_service.MarkRecommendationSucceededRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_succeeded] + + # 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 mark_recommendation_failed(self, + request: recommender_service.MarkRecommendationFailedRequest = None, + *, + name: str = None, + state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, + etag: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Args: + request (google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest): + The request object. Request for the + `MarkRecommendationFailed` Method. + name (str): + Required. Name of the recommendation. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites + any existing ``state_metadata``. Keys must match the + regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match + the regex /^[a-zA-Z0-9_./-]{0,255}$/. + + This corresponds to the ``state_metadata`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + etag (str): + Required. Fingerprint of the + Recommendation. Provides optimistic + locking. + + This corresponds to the ``etag`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (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.recommender_v1beta1.types.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + # 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, state_metadata, etag]) + if request is 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 recommender_service.MarkRecommendationFailedRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recommender_service.MarkRecommendationFailedRequest): + request = recommender_service.MarkRecommendationFailedRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if state_metadata is not None: + request.state_metadata = state_metadata + if etag is not None: + request.etag = etag + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_failed] + + # 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 + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-recommender", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "RecommenderClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py new file mode 100644 index 0000000..ab7b2b4 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py @@ -0,0 +1,264 @@ +# -*- 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.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service + + +class ListInsightsPager: + """A pager for iterating through ``list_insights`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``insights`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListInsights`` requests and continue to iterate + through the ``insights`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` + 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[..., recommender_service.ListInsightsResponse], + request: recommender_service.ListInsightsRequest, + response: recommender_service.ListInsightsResponse, + *, + 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.recommender_v1beta1.types.ListInsightsRequest): + The initial request object. + response (google.cloud.recommender_v1beta1.types.ListInsightsResponse): + 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 = recommender_service.ListInsightsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[recommender_service.ListInsightsResponse]: + 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[insight.Insight]: + for page in self.pages: + yield from page.insights + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListInsightsAsyncPager: + """A pager for iterating through ``list_insights`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``insights`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListInsights`` requests and continue to iterate + through the ``insights`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` + 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[recommender_service.ListInsightsResponse]], + request: recommender_service.ListInsightsRequest, + response: recommender_service.ListInsightsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recommender_v1beta1.types.ListInsightsRequest): + The initial request object. + response (google.cloud.recommender_v1beta1.types.ListInsightsResponse): + 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 = recommender_service.ListInsightsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[recommender_service.ListInsightsResponse]: + 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[insight.Insight]: + async def async_generator(): + async for page in self.pages: + for response in page.insights: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRecommendationsPager: + """A pager for iterating through ``list_recommendations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``recommendations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRecommendations`` requests and continue to iterate + through the ``recommendations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` + 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[..., recommender_service.ListRecommendationsResponse], + request: recommender_service.ListRecommendationsRequest, + response: recommender_service.ListRecommendationsResponse, + *, + 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.recommender_v1beta1.types.ListRecommendationsRequest): + The initial request object. + response (google.cloud.recommender_v1beta1.types.ListRecommendationsResponse): + 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 = recommender_service.ListRecommendationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[recommender_service.ListRecommendationsResponse]: + 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[recommendation.Recommendation]: + for page in self.pages: + yield from page.recommendations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRecommendationsAsyncPager: + """A pager for iterating through ``list_recommendations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``recommendations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRecommendations`` requests and continue to iterate + through the ``recommendations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` + 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[recommender_service.ListRecommendationsResponse]], + request: recommender_service.ListRecommendationsRequest, + response: recommender_service.ListRecommendationsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.recommender_v1beta1.types.ListRecommendationsRequest): + The initial request object. + response (google.cloud.recommender_v1beta1.types.ListRecommendationsResponse): + 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 = recommender_service.ListRecommendationsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[recommender_service.ListRecommendationsResponse]: + 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[recommendation.Recommendation]: + async def async_generator(): + async for page in self.pages: + for response in page.recommendations: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py new file mode 100644 index 0000000..18245b5 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/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 RecommenderTransport +from .grpc import RecommenderGrpcTransport +from .grpc_asyncio import RecommenderGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] +_transport_registry['grpc'] = RecommenderGrpcTransport +_transport_registry['grpc_asyncio'] = RecommenderGrpcAsyncIOTransport + +__all__ = ( + 'RecommenderTransport', + 'RecommenderGrpcTransport', + 'RecommenderGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py new file mode 100644 index 0000000..8d5283b --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py @@ -0,0 +1,296 @@ +# -*- 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 + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_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 as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-recommender', + ).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 = google.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 + + +class RecommenderTransport(abc.ABC): + """Abstract transport class for Recommender.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'recommender.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # 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 + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is 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 + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_insights: gapic_v1.method.wrap_method( + self.list_insights, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_insight: gapic_v1.method.wrap_method( + self.get_insight, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.mark_insight_accepted: gapic_v1.method.wrap_method( + self.mark_insight_accepted, + default_timeout=60.0, + client_info=client_info, + ), + self.list_recommendations: gapic_v1.method.wrap_method( + self.list_recommendations, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_recommendation: gapic_v1.method.wrap_method( + self.get_recommendation, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_claimed: gapic_v1.method.wrap_method( + self.mark_recommendation_claimed, + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_succeeded: gapic_v1.method.wrap_method( + self.mark_recommendation_succeeded, + default_timeout=60.0, + client_info=client_info, + ), + self.mark_recommendation_failed: gapic_v1.method.wrap_method( + self.mark_recommendation_failed, + default_timeout=60.0, + client_info=client_info, + ), + } + + @property + def list_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + Union[ + recommender_service.ListInsightsResponse, + Awaitable[recommender_service.ListInsightsResponse] + ]]: + raise NotImplementedError() + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + Union[ + insight.Insight, + Awaitable[insight.Insight] + ]]: + raise NotImplementedError() + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + Union[ + insight.Insight, + Awaitable[insight.Insight] + ]]: + raise NotImplementedError() + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + Union[ + recommender_service.ListRecommendationsResponse, + Awaitable[recommender_service.ListRecommendationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + Union[ + recommendation.Recommendation, + Awaitable[recommendation.Recommendation] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'RecommenderTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py new file mode 100644 index 0000000..db4df9d --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py @@ -0,0 +1,482 @@ +# -*- 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 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service +from .base import RecommenderTransport, DEFAULT_CLIENT_INFO + + +class RecommenderGrpcTransport(RecommenderTransport): + """gRPC backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = 'recommender.googleapis.com', + credentials: ga_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, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + 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 = 'recommender.googleapis.com', + credentials: ga_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. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def list_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + recommender_service.ListInsightsResponse]: + r"""Return a callable for the list insights method over gRPC. + + Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Returns: + Callable[[~.ListInsightsRequest], + ~.ListInsightsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insights' not in self._stubs: + self._stubs['list_insights'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/ListInsights', + request_serializer=recommender_service.ListInsightsRequest.serialize, + response_deserializer=recommender_service.ListInsightsResponse.deserialize, + ) + return self._stubs['list_insights'] + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + insight.Insight]: + r"""Return a callable for the get insight method over gRPC. + + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Returns: + Callable[[~.GetInsightRequest], + ~.Insight]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insight' not in self._stubs: + self._stubs['get_insight'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/GetInsight', + request_serializer=recommender_service.GetInsightRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['get_insight'] + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + insight.Insight]: + r"""Return a callable for the mark insight accepted method over gRPC. + + Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Returns: + Callable[[~.MarkInsightAcceptedRequest], + ~.Insight]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_insight_accepted' not in self._stubs: + self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkInsightAccepted', + request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['mark_insight_accepted'] + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + recommender_service.ListRecommendationsResponse]: + r"""Return a callable for the list recommendations method over gRPC. + + Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Returns: + Callable[[~.ListRecommendationsRequest], + ~.ListRecommendationsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendations' not in self._stubs: + self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/ListRecommendations', + request_serializer=recommender_service.ListRecommendationsRequest.serialize, + response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, + ) + return self._stubs['list_recommendations'] + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + recommendation.Recommendation]: + r"""Return a callable for the get recommendation method over gRPC. + + Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Returns: + Callable[[~.GetRecommendationRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendation' not in self._stubs: + self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/GetRecommendation', + request_serializer=recommender_service.GetRecommendationRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['get_recommendation'] + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation claimed method over gRPC. + + Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationClaimedRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_claimed' not in self._stubs: + self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationClaimed', + request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_claimed'] + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation succeeded method over gRPC. + + Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationSucceededRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_succeeded' not in self._stubs: + self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationSucceeded', + request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_succeeded'] + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + recommendation.Recommendation]: + r"""Return a callable for the mark recommendation failed method over gRPC. + + Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationFailedRequest], + ~.Recommendation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_failed' not in self._stubs: + self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationFailed', + request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_failed'] + + +__all__ = ( + 'RecommenderGrpcTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py new file mode 100644 index 0000000..c55100e --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py @@ -0,0 +1,486 @@ +# -*- 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.auth import credentials as ga_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.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service +from .base import RecommenderTransport, DEFAULT_CLIENT_INFO +from .grpc import RecommenderGrpcTransport + + +class RecommenderGrpcAsyncIOTransport(RecommenderTransport): + """gRPC AsyncIO backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = 'recommender.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'recommender.googleapis.com', + credentials: ga_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, + always_use_jwt_access: Optional[bool] = False, + ) -> 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + 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_insights(self) -> Callable[ + [recommender_service.ListInsightsRequest], + Awaitable[recommender_service.ListInsightsResponse]]: + r"""Return a callable for the list insights method over gRPC. + + Lists insights for a Cloud project. Requires the + recommender.*.list IAM permission for the specified insight + type. + + Returns: + Callable[[~.ListInsightsRequest], + Awaitable[~.ListInsightsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insights' not in self._stubs: + self._stubs['list_insights'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/ListInsights', + request_serializer=recommender_service.ListInsightsRequest.serialize, + response_deserializer=recommender_service.ListInsightsResponse.deserialize, + ) + return self._stubs['list_insights'] + + @property + def get_insight(self) -> Callable[ + [recommender_service.GetInsightRequest], + Awaitable[insight.Insight]]: + r"""Return a callable for the get insight method over gRPC. + + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + + Returns: + Callable[[~.GetInsightRequest], + Awaitable[~.Insight]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_insight' not in self._stubs: + self._stubs['get_insight'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/GetInsight', + request_serializer=recommender_service.GetInsightRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['get_insight'] + + @property + def mark_insight_accepted(self) -> Callable[ + [recommender_service.MarkInsightAcceptedRequest], + Awaitable[insight.Insight]]: + r"""Return a callable for the mark insight accepted method over gRPC. + + Marks the Insight State as Accepted. Users can use this method + to indicate to the Recommender API that they have applied some + action based on the insight. This stops the insight content from + being updated. + + MarkInsightAccepted can be applied to insights in ACTIVE state. + Requires the recommender.*.update IAM permission for the + specified insight. + + Returns: + Callable[[~.MarkInsightAcceptedRequest], + Awaitable[~.Insight]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_insight_accepted' not in self._stubs: + self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkInsightAccepted', + request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, + response_deserializer=insight.Insight.deserialize, + ) + return self._stubs['mark_insight_accepted'] + + @property + def list_recommendations(self) -> Callable[ + [recommender_service.ListRecommendationsRequest], + Awaitable[recommender_service.ListRecommendationsResponse]]: + r"""Return a callable for the list recommendations method over gRPC. + + Lists recommendations for a Cloud project. Requires the + recommender.*.list IAM permission for the specified recommender. + + Returns: + Callable[[~.ListRecommendationsRequest], + Awaitable[~.ListRecommendationsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendations' not in self._stubs: + self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/ListRecommendations', + request_serializer=recommender_service.ListRecommendationsRequest.serialize, + response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, + ) + return self._stubs['list_recommendations'] + + @property + def get_recommendation(self) -> Callable[ + [recommender_service.GetRecommendationRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the get recommendation method over gRPC. + + Gets the requested recommendation. Requires the + recommender.*.get IAM permission for the specified recommender. + + Returns: + Callable[[~.GetRecommendationRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-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_recommendation' not in self._stubs: + self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/GetRecommendation', + request_serializer=recommender_service.GetRecommendationRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['get_recommendation'] + + @property + def mark_recommendation_claimed(self) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation claimed method over gRPC. + + Marks the Recommendation State as Claimed. Users can use this + method to indicate to the Recommender API that they are starting + to apply the recommendation themselves. This stops the + recommendation content from being updated. Associated insights + are frozen and placed in the ACCEPTED state. + + MarkRecommendationClaimed can be applied to recommendations in + CLAIMED or ACTIVE state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationClaimedRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_claimed' not in self._stubs: + self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationClaimed', + request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_claimed'] + + @property + def mark_recommendation_succeeded(self) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation succeeded method over gRPC. + + Marks the Recommendation State as Succeeded. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation was successful. + This stops the recommendation content from being updated. + Associated insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationSucceeded can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationSucceededRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_succeeded' not in self._stubs: + self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationSucceeded', + request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_succeeded'] + + @property + def mark_recommendation_failed(self) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + Awaitable[recommendation.Recommendation]]: + r"""Return a callable for the mark recommendation failed method over gRPC. + + Marks the Recommendation State as Failed. Users can use this + method to indicate to the Recommender API that they have applied + the recommendation themselves, and the operation failed. This + stops the recommendation content from being updated. Associated + insights are frozen and placed in the ACCEPTED state. + + MarkRecommendationFailed can be applied to recommendations in + ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. + + Requires the recommender.*.update IAM permission for the + specified recommender. + + Returns: + Callable[[~.MarkRecommendationFailedRequest], + Awaitable[~.Recommendation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'mark_recommendation_failed' not in self._stubs: + self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( + '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationFailed', + request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, + response_deserializer=recommendation.Recommendation.deserialize, + ) + return self._stubs['mark_recommendation_failed'] + + +__all__ = ( + 'RecommenderGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py new file mode 100644 index 0000000..1238196 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/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 .insight import ( + Insight, + InsightStateInfo, +) +from .recommendation import ( + CostProjection, + Impact, + Operation, + OperationGroup, + Recommendation, + RecommendationContent, + RecommendationStateInfo, + ValueMatcher, +) +from .recommender_service import ( + GetInsightRequest, + GetRecommendationRequest, + ListInsightsRequest, + ListInsightsResponse, + ListRecommendationsRequest, + ListRecommendationsResponse, + MarkInsightAcceptedRequest, + MarkRecommendationClaimedRequest, + MarkRecommendationFailedRequest, + MarkRecommendationSucceededRequest, +) + +__all__ = ( + 'Insight', + 'InsightStateInfo', + 'CostProjection', + 'Impact', + 'Operation', + 'OperationGroup', + 'Recommendation', + 'RecommendationContent', + 'RecommendationStateInfo', + 'ValueMatcher', + 'GetInsightRequest', + 'GetRecommendationRequest', + 'ListInsightsRequest', + 'ListInsightsResponse', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'MarkInsightAcceptedRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationFailedRequest', + 'MarkRecommendationSucceededRequest', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py new file mode 100644 index 0000000..b6a5e8e --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py @@ -0,0 +1,170 @@ +# -*- 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 duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1beta1', + manifest={ + 'Insight', + 'InsightStateInfo', + }, +) + + +class Insight(proto.Message): + r"""An insight along with the information used to derive the + insight. The insight may have associated recomendations as well. + + Attributes: + name (str): + Name of the insight. + description (str): + Free-form human readable summary in English. + The maximum length is 500 characters. + target_resources (Sequence[str]): + Fully qualified resource names that this + insight is targeting. + insight_subtype (str): + Insight subtype. Insight content schema will + be stable for a given subtype. + content (google.protobuf.struct_pb2.Struct): + A struct of custom fields to explain the + insight. Example: "grantedPermissionsCount": + "1000". + last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): + Timestamp of the latest data used to generate + the insight. + observation_period (google.protobuf.duration_pb2.Duration): + Observation period that led to the insight. The source data + used to generate the insight ends at last_refresh_time and + begins at (last_refresh_time - observation_period). + state_info (google.cloud.recommender_v1beta1.types.InsightStateInfo): + Information state and metadata. + category (google.cloud.recommender_v1beta1.types.Insight.Category): + Category being targeted by the insight. + etag (str): + Fingerprint of the Insight. Provides + optimistic locking when updating states. + associated_recommendations (Sequence[google.cloud.recommender_v1beta1.types.Insight.RecommendationReference]): + Recommendations derived from this insight. + """ + class Category(proto.Enum): + r"""Insight category.""" + CATEGORY_UNSPECIFIED = 0 + COST = 1 + SECURITY = 2 + PERFORMANCE = 3 + MANAGEABILITY = 4 + + class RecommendationReference(proto.Message): + r"""Reference to an associated recommendation. + Attributes: + recommendation (str): + Recommendation resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + """ + + recommendation = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + description = proto.Field( + proto.STRING, + number=2, + ) + target_resources = proto.RepeatedField( + proto.STRING, + number=9, + ) + insight_subtype = proto.Field( + proto.STRING, + number=10, + ) + content = proto.Field( + proto.MESSAGE, + number=3, + message=struct_pb2.Struct, + ) + last_refresh_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + observation_period = proto.Field( + proto.MESSAGE, + number=5, + message=duration_pb2.Duration, + ) + state_info = proto.Field( + proto.MESSAGE, + number=6, + message='InsightStateInfo', + ) + category = proto.Field( + proto.ENUM, + number=7, + enum=Category, + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + associated_recommendations = proto.RepeatedField( + proto.MESSAGE, + number=8, + message=RecommendationReference, + ) + + +class InsightStateInfo(proto.Message): + r"""Information related to insight state. + Attributes: + state (google.cloud.recommender_v1beta1.types.InsightStateInfo.State): + Insight state. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.InsightStateInfo.StateMetadataEntry]): + A map of metadata for the state, provided by + user or automations systems. + """ + class State(proto.Enum): + r"""Represents insight state.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 1 + ACCEPTED = 2 + DISMISSED = 3 + + state = proto.Field( + proto.ENUM, + number=1, + enum=State, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py new file mode 100644 index 0000000..efe021f --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py @@ -0,0 +1,420 @@ +# -*- 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 duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import money_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1beta1', + manifest={ + 'Recommendation', + 'RecommendationContent', + 'OperationGroup', + 'Operation', + 'ValueMatcher', + 'CostProjection', + 'Impact', + 'RecommendationStateInfo', + }, +) + + +class Recommendation(proto.Message): + r"""A recommendation along with a suggested action. E.g., a + rightsizing recommendation for an underutilized VM, IAM role + recommendations, etc + + Attributes: + name (str): + Name of recommendation. + description (str): + Free-form human readable summary in English. + The maximum length is 500 characters. + recommender_subtype (str): + Contains an identifier for a subtype of recommendations + produced for the same recommender. Subtype is a function of + content and impact, meaning a new subtype might be added + when significant changes to ``content`` or + ``primary_impact.category`` are introduced. See the + Recommenders section to see a list of subtypes for a given + Recommender. + + Examples: For recommender = "google.iam.policy.Recommender", + recommender_subtype can be one of + "REMOVE_ROLE"/"REPLACE_ROLE". + last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): + Last time this recommendation was refreshed + by the system that created it in the first + place. + primary_impact (google.cloud.recommender_v1beta1.types.Impact): + The primary impact that this recommendation + can have while trying to optimize for one + category. + additional_impact (Sequence[google.cloud.recommender_v1beta1.types.Impact]): + Optional set of additional impact that this + recommendation may have when trying to optimize + for the primary category. These may be positive + or negative. + content (google.cloud.recommender_v1beta1.types.RecommendationContent): + Content of the recommendation describing + recommended changes to resources. + state_info (google.cloud.recommender_v1beta1.types.RecommendationStateInfo): + Information for state. Contains state and + metadata. + etag (str): + Fingerprint of the Recommendation. Provides + optimistic locking when updating states. + associated_insights (Sequence[google.cloud.recommender_v1beta1.types.Recommendation.InsightReference]): + Insights that led to this recommendation. + """ + + class InsightReference(proto.Message): + r"""Reference to an associated insight. + Attributes: + insight (str): + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + """ + + insight = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + description = proto.Field( + proto.STRING, + number=2, + ) + recommender_subtype = proto.Field( + proto.STRING, + number=12, + ) + last_refresh_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + primary_impact = proto.Field( + proto.MESSAGE, + number=5, + message='Impact', + ) + additional_impact = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='Impact', + ) + content = proto.Field( + proto.MESSAGE, + number=7, + message='RecommendationContent', + ) + state_info = proto.Field( + proto.MESSAGE, + number=10, + message='RecommendationStateInfo', + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + associated_insights = proto.RepeatedField( + proto.MESSAGE, + number=14, + message=InsightReference, + ) + + +class RecommendationContent(proto.Message): + r"""Contains what resources are changing and how they are + changing. + + Attributes: + operation_groups (Sequence[google.cloud.recommender_v1beta1.types.OperationGroup]): + Operations to one or more Google Cloud + resources grouped in such a way that, all + operations within one group are expected to be + performed atomically and in an order. + """ + + operation_groups = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='OperationGroup', + ) + + +class OperationGroup(proto.Message): + r"""Group of operations that need to be performed atomically. + Attributes: + operations (Sequence[google.cloud.recommender_v1beta1.types.Operation]): + List of operations across one or more + resources that belong to this group. Loosely + based on RFC6902 and should be performed in the + order they appear. + """ + + operations = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Operation', + ) + + +class Operation(proto.Message): + r"""Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: + + - Custom filters for describing partial array patch. + - Extended path values for describing nested arrays. + - Custom fields for describing the resource for which the operation + is being described. + - Allows extension to custom operations not natively supported by + RFC6902. See https://tools.ietf.org/html/rfc6902 for details on + the original RFC. + + Attributes: + action (str): + Type of this operation. Contains one of + 'and', 'remove', 'replace', 'move', 'copy', + 'test' and 'custom' operations. This field is + case-insensitive and always populated. + resource_type (str): + Type of GCP resource being modified/tested. + This field is always populated. Example: + cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + resource (str): + Contains the fully qualified resource name. + This field is always populated. ex: + //cloudresourcemanager.googleapis.com/projects/foo. + path (str): + Path to the target field being operated on. + If the operation is at the resource level, then + path should be "/". This field is always + populated. + source_resource (str): + Can be set with action 'copy' to copy resource configuration + across different resources of the same type. Example: A + resource clone can be done via action = 'copy', path = "/", + from = "/", source_resource = and resource_name = . This + field is empty for all other values of ``action``. + source_path (str): + Can be set with action 'copy' or 'move' to indicate the + source field within resource or source_resource, ignored if + provided for other operation types. + value (google.protobuf.struct_pb2.Value): + Value for the ``path`` field. Will be set for + actions:'add'/'replace'. Maybe set for action: 'test'. + Either this or ``value_matcher`` will be set for 'test' + operation. An exact match must be performed. + value_matcher (google.cloud.recommender_v1beta1.types.ValueMatcher): + Can be set for action 'test' for advanced matching for the + value of 'path' field. Either this or ``value`` will be set + for 'test' operation. + path_filters (Sequence[google.cloud.recommender_v1beta1.types.Operation.PathFiltersEntry]): + Set of filters to apply if ``path`` refers to array elements + or nested array elements in order to narrow down to a single + unique element that is being tested/modified. This is + intended to be an exact match per filter. To perform + advanced matching, use path_value_matchers. + + - Example: { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } + - Example: { "/bindings/*/role": "roles/owner" + "/bindings/*/condition" : null } + - Example: { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", + "y@example.com"] } When both path_filters and + path_value_matchers are set, an implicit AND must be + performed. + path_value_matchers (Sequence[google.cloud.recommender_v1beta1.types.Operation.PathValueMatchersEntry]): + Similar to path_filters, this contains set of filters to + apply if ``path`` field referes to array elements. This is + meant to support value matching beyond exact match. To + perform exact match, use path_filters. When both + path_filters and path_value_matchers are set, an implicit + AND must be performed. + """ + + action = proto.Field( + proto.STRING, + number=1, + ) + resource_type = proto.Field( + proto.STRING, + number=2, + ) + resource = proto.Field( + proto.STRING, + number=3, + ) + path = proto.Field( + proto.STRING, + number=4, + ) + source_resource = proto.Field( + proto.STRING, + number=5, + ) + source_path = proto.Field( + proto.STRING, + number=6, + ) + value = proto.Field( + proto.MESSAGE, + number=7, + oneof='path_value', + message=struct_pb2.Value, + ) + value_matcher = proto.Field( + proto.MESSAGE, + number=10, + oneof='path_value', + message='ValueMatcher', + ) + path_filters = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=8, + message=struct_pb2.Value, + ) + path_value_matchers = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=11, + message='ValueMatcher', + ) + + +class ValueMatcher(proto.Message): + r"""Contains various matching options for values for a GCP + resource field. + + Attributes: + matches_pattern (str): + To be used for full regex matching. The + regular expression is using the Google RE2 + syntax + (https://github.com/google/re2/wiki/Syntax), so + to be used with RE2::FullMatch + """ + + matches_pattern = proto.Field( + proto.STRING, + number=1, + oneof='match_variant', + ) + + +class CostProjection(proto.Message): + r"""Contains metadata about how much money a recommendation can + save or incur. + + Attributes: + cost (google.type.money_pb2.Money): + An approximate projection on amount saved or + amount incurred. Negative cost units indicate + cost savings and positive cost units indicate + increase. See google.type.Money documentation + for positive/negative units. + duration (google.protobuf.duration_pb2.Duration): + Duration for which this cost applies. + """ + + cost = proto.Field( + proto.MESSAGE, + number=1, + message=money_pb2.Money, + ) + duration = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + +class Impact(proto.Message): + r"""Contains the impact a recommendation can have for a given + category. + + Attributes: + category (google.cloud.recommender_v1beta1.types.Impact.Category): + Category that is being targeted. + cost_projection (google.cloud.recommender_v1beta1.types.CostProjection): + Use with CategoryType.COST + """ + class Category(proto.Enum): + r"""The category of the impact.""" + CATEGORY_UNSPECIFIED = 0 + COST = 1 + SECURITY = 2 + PERFORMANCE = 3 + MANAGEABILITY = 4 + + category = proto.Field( + proto.ENUM, + number=1, + enum=Category, + ) + cost_projection = proto.Field( + proto.MESSAGE, + number=100, + oneof='projection', + message='CostProjection', + ) + + +class RecommendationStateInfo(proto.Message): + r"""Information for state. Contains state and metadata. + Attributes: + state (google.cloud.recommender_v1beta1.types.RecommendationStateInfo.State): + The state of the recommendation, Eg ACTIVE, + SUCCEEDED, FAILED. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.RecommendationStateInfo.StateMetadataEntry]): + A map of metadata for the state, provided by + user or automations systems. + """ + class State(proto.Enum): + r"""Represents Recommendation State.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 1 + CLAIMED = 6 + SUCCEEDED = 3 + FAILED = 4 + DISMISSED = 5 + + state = proto.Field( + proto.ENUM, + number=1, + enum=State, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py new file mode 100644 index 0000000..2aa4b13 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py @@ -0,0 +1,335 @@ +# -*- 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.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation + + +__protobuf__ = proto.module( + package='google.cloud.recommender.v1beta1', + manifest={ + 'ListInsightsRequest', + 'ListInsightsResponse', + 'GetInsightRequest', + 'MarkInsightAcceptedRequest', + 'ListRecommendationsRequest', + 'ListRecommendationsResponse', + 'GetRecommendationRequest', + 'MarkRecommendationClaimedRequest', + 'MarkRecommendationSucceededRequest', + 'MarkRecommendationFailedRequest', + }, +) + + +class ListInsightsRequest(proto.Message): + r"""Request for the ``ListInsights`` method. + Attributes: + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID + refers to supported insight types: + https://cloud.google.com/recommender/docs/insights/insight-types. + page_size (int): + Optional. The maximum number of results to + return from this request. Non-positive values + are ignored. If not specified, the server will + determine the number of results to return. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters must be + identical to those in the previous call. + filter (str): + Optional. Filter expression to restrict the insights + returned. Supported filter fields: state Eg: + \`state:"DISMISSED" or state:"ACTIVE". + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + + +class ListInsightsResponse(proto.Message): + r"""Response to the ``ListInsights`` method. + Attributes: + insights (Sequence[google.cloud.recommender_v1beta1.types.Insight]): + The set of insights for the ``parent`` resource. + next_page_token (str): + A token that can be used to request the next + page of results. This field is empty if there + are no additional results. + """ + + @property + def raw_page(self): + return self + + insights = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=insight.Insight, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetInsightRequest(proto.Message): + r"""Request to the ``GetInsight`` method. + Attributes: + name (str): + Required. Name of the insight. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class MarkInsightAcceptedRequest(proto.Message): + r"""Request for the ``MarkInsightAccepted`` method. + Attributes: + name (str): + Required. Name of the insight. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): + Optional. State properties user wish to include with this + state. Full replace of the current state_metadata. + etag (str): + Required. Fingerprint of the Insight. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class ListRecommendationsRequest(proto.Message): + r"""Request for the ``ListRecommendations`` method. + Attributes: + parent (str): + Required. The container resource on which to execute the + request. Acceptable formats: + + 1. + + "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + + LOCATION here refers to GCP Locations: + https://cloud.google.com/about/locations/ RECOMMENDER_ID + refers to supported recommenders: + https://cloud.google.com/recommender/docs/recommenders. + page_size (int): + Optional. The maximum number of results to + return from this request. Non-positive values + are ignored. If not specified, the server will + determine the number of results to return. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters must be + identical to those in the previous call. + filter (str): + Filter expression to restrict the recommendations returned. + Supported filter fields: state_info.state Eg: + \`state_info.state:"DISMISSED" or state_info.state:"FAILED". + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=5, + ) + + +class ListRecommendationsResponse(proto.Message): + r"""Response to the ``ListRecommendations`` method. + Attributes: + recommendations (Sequence[google.cloud.recommender_v1beta1.types.Recommendation]): + The set of recommendations for the ``parent`` resource. + next_page_token (str): + A token that can be used to request the next + page of results. This field is empty if there + are no additional results. + """ + + @property + def raw_page(self): + return self + + recommendations = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=recommendation.Recommendation, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRecommendationRequest(proto.Message): + r"""Request to the ``GetRecommendation`` method. + Attributes: + name (str): + Required. Name of the recommendation. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class MarkRecommendationClaimedRequest(proto.Message): + r"""Request for the ``MarkRecommendationClaimed`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class MarkRecommendationSucceededRequest(proto.Message): + r"""Request for the ``MarkRecommendationSucceeded`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class MarkRecommendationFailedRequest(proto.Message): + r"""Request for the ``MarkRecommendationFailed`` Method. + Attributes: + name (str): + Required. Name of the recommendation. + state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): + State properties to include with this state. Overwrites any + existing ``state_metadata``. Keys must match the regex + /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex + /^[a-zA-Z0-9_./-]{0,255}$/. + etag (str): + Required. Fingerprint of the Recommendation. + Provides optimistic locking. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + state_metadata = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/mypy.ini b/owl-bot-staging/v1beta1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1beta1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1beta1/noxfile.py b/owl-bot-staging/v1beta1/noxfile.py new file mode 100644 index 0000000..f727576 --- /dev/null +++ b/owl-bot-staging/v1beta1/noxfile.py @@ -0,0 +1,132 @@ +# -*- 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/recommender_v1beta1/', + '--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', 'types-pkg_resources') + 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/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py b/owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py new file mode 100644 index 0000000..c0fe445 --- /dev/null +++ b/owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py @@ -0,0 +1,183 @@ +#! /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 recommenderCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'get_insight': ('name', ), + 'get_recommendation': ('name', ), + 'list_insights': ('parent', 'page_size', 'page_token', 'filter', ), + 'list_recommendations': ('parent', 'page_size', 'page_token', 'filter', ), + 'mark_insight_accepted': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_claimed': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_failed': ('name', 'etag', 'state_metadata', ), + 'mark_recommendation_succeeded': ('name', 'etag', 'state_metadata', ), + } + + 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=recommenderCallTransformer(), +): + """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 recommender client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1beta1/setup.py b/owl-bot-staging/v1beta1/setup.py new file mode 100644 index 0000000..fc7260d --- /dev/null +++ b/owl-bot-staging/v1beta1/setup.py @@ -0,0 +1,54 @@ +# -*- 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-recommender', + 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.27.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + 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', + 'Programming Language :: Python :: 3.9', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1beta1/tests/__init__.py b/owl-bot-staging/v1beta1/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1beta1/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/v1beta1/tests/unit/__init__.py b/owl-bot-staging/v1beta1/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1beta1/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/v1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1beta1/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/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__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/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py new file mode 100644 index 0000000..eb54dc6 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py @@ -0,0 +1,3377 @@ +# -*- 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.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.recommender_v1beta1.services.recommender import RecommenderAsyncClient +from google.cloud.recommender_v1beta1.services.recommender import RecommenderClient +from google.cloud.recommender_v1beta1.services.recommender import pagers +from google.cloud.recommender_v1beta1.services.recommender import transports +from google.cloud.recommender_v1beta1.services.recommender.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_service +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import struct_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the 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", +) + +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 RecommenderClient._get_default_mtls_endpoint(None) is None + assert RecommenderClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert RecommenderClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + RecommenderClient, + RecommenderAsyncClient, +]) +def test_recommender_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'recommender.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.RecommenderGrpcTransport, "grpc"), + (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + RecommenderClient, + RecommenderAsyncClient, +]) +def test_recommender_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + 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 == 'recommender.googleapis.com:443' + + +def test_recommender_client_get_transport_class(): + transport = RecommenderClient.get_transport_class() + available_transports = [ + transports.RecommenderGrpcTransport, + ] + assert transport in available_transports + + transport = RecommenderClient.get_transport_class("grpc") + assert transport == transports.RecommenderGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) +@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) +def test_recommender_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(RecommenderClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(RecommenderClient, '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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "true"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "false"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) +@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_recommender_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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + # 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, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_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, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), + (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recommender_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, + always_use_jwt_access=True, + ) + + +def test_recommender_client_client_options_from_dict(): + with mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = RecommenderClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_list_insights(transport: str = 'grpc', request_type=recommender_service.ListInsightsRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_insights(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_insights_from_dict(): + test_list_insights(request_type=dict) + + +def test_list_insights_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + client.list_insights() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + +@pytest.mark.asyncio +async def test_list_insights_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListInsightsRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_insights(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListInsightsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_insights_async_from_dict(): + await test_list_insights_async(request_type=dict) + + +def test_list_insights_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListInsightsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + call.return_value = recommender_service.ListInsightsResponse() + client.list_insights(request) + + # Establish that the 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_insights_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListInsightsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) + await client.list_insights(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_insights_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_insights( + 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_insights_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_insights( + recommender_service.ListInsightsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_insights_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListInsightsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_insights( + 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_insights_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_insights( + recommender_service.ListInsightsRequest(), + parent='parent_value', + ) + + +def test_list_insights_pager(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_insights(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, insight.Insight) + for i in results) + +def test_list_insights_pages(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + pages = list(client.list_insights(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_insights_async_pager(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_insights(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, insight.Insight) + for i in responses) + +@pytest.mark.asyncio +async def test_list_insights_async_pages(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_insights), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token='abc', + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token='def', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token='ghi', + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_insights(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_insight(transport: str = 'grpc', request_type=recommender_service.GetInsightRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + ) + response = client.get_insight(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +def test_get_insight_from_dict(): + test_get_insight(request_type=dict) + + +def test_get_insight_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + client.get_insight() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + +@pytest.mark.asyncio +async def test_get_insight_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetInsightRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + )) + response = await client.get_insight(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetInsightRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_insight_async_from_dict(): + await test_get_insight_async(request_type=dict) + + +def test_get_insight_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetInsightRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + call.return_value = insight.Insight() + client.get_insight(request) + + # Establish that the 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_insight_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetInsightRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + await client.get_insight(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_insight_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_insight( + 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_insight_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_insight( + recommender_service.GetInsightRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_insight_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_insight), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_insight( + 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_insight_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_insight( + recommender_service.GetInsightRequest(), + name='name_value', + ) + + +def test_mark_insight_accepted(transport: str = 'grpc', request_type=recommender_service.MarkInsightAcceptedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + ) + response = client.mark_insight_accepted(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +def test_mark_insight_accepted_from_dict(): + test_mark_insight_accepted(request_type=dict) + + +def test_mark_insight_accepted_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + client.mark_insight_accepted() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkInsightAcceptedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( + name='name_value', + description='description_value', + target_resources=['target_resources_value'], + insight_subtype='insight_subtype_value', + category=insight.Insight.Category.COST, + etag='etag_value', + )) + response = await client.mark_insight_accepted(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkInsightAcceptedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.target_resources == ['target_resources_value'] + assert response.insight_subtype == 'insight_subtype_value' + assert response.category == insight.Insight.Category.COST + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_async_from_dict(): + await test_mark_insight_accepted_async(request_type=dict) + + +def test_mark_insight_accepted_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkInsightAcceptedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + call.return_value = insight.Insight() + client.mark_insight_accepted(request) + + # Establish that the 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_mark_insight_accepted_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkInsightAcceptedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + await client.mark_insight_accepted(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_mark_insight_accepted_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_insight_accepted( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_insight_accepted_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_insight_accepted), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = insight.Insight() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_insight_accepted( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_insight_accepted_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_list_recommendations(transport: str = 'grpc', request_type=recommender_service.ListRecommendationsRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_recommendations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_recommendations_from_dict(): + test_list_recommendations(request_type=dict) + + +def test_list_recommendations_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + client.list_recommendations() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + +@pytest.mark.asyncio +async def test_list_recommendations_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListRecommendationsRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_recommendations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.ListRecommendationsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_recommendations_async_from_dict(): + await test_list_recommendations_async(request_type=dict) + + +def test_list_recommendations_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListRecommendationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + call.return_value = recommender_service.ListRecommendationsResponse() + client.list_recommendations(request) + + # Establish that the 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_recommendations_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.ListRecommendationsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) + await client.list_recommendations(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_recommendations_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_recommendations( + parent='parent_value', + filter='filter_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' + assert args[0].filter == 'filter_value' + + +def test_list_recommendations_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_recommendations( + recommender_service.ListRecommendationsRequest(), + parent='parent_value', + filter='filter_value', + ) + + +@pytest.mark.asyncio +async def test_list_recommendations_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommender_service.ListRecommendationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_recommendations( + parent='parent_value', + filter='filter_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' + assert args[0].filter == 'filter_value' + + +@pytest.mark.asyncio +async def test_list_recommendations_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_recommendations( + recommender_service.ListRecommendationsRequest(), + parent='parent_value', + filter='filter_value', + ) + + +def test_list_recommendations_pager(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_recommendations(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, recommendation.Recommendation) + for i in results) + +def test_list_recommendations_pages(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + pages = list(client.list_recommendations(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_recommendations_async_pager(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_recommendations(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, recommendation.Recommendation) + for i in responses) + +@pytest.mark.asyncio +async def test_list_recommendations_async_pages(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recommendations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token='abc', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token='def', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token='ghi', + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_recommendations(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_recommendation(transport: str = 'grpc', request_type=recommender_service.GetRecommendationRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.get_recommendation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_get_recommendation_from_dict(): + test_get_recommendation(request_type=dict) + + +def test_get_recommendation_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + client.get_recommendation() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + +@pytest.mark.asyncio +async def test_get_recommendation_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetRecommendationRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an 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_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.get_recommendation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.GetRecommendationRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_get_recommendation_async_from_dict(): + await test_get_recommendation_async(request_type=dict) + + +def test_get_recommendation_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetRecommendationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.get_recommendation(request) + + # Establish that the 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_recommendation_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.GetRecommendationRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.get_recommendation(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_recommendation_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_recommendation( + 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_recommendation_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_recommendation( + recommender_service.GetRecommendationRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_recommendation_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_recommendation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_recommendation( + 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_recommendation_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_recommendation( + recommender_service.GetRecommendationRequest(), + name='name_value', + ) + + +def test_mark_recommendation_claimed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationClaimedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_claimed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_claimed_from_dict(): + test_mark_recommendation_claimed(request_type=dict) + + +def test_mark_recommendation_claimed_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + client.mark_recommendation_claimed() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationClaimedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_claimed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationClaimedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_async_from_dict(): + await test_mark_recommendation_claimed_async(request_type=dict) + + +def test_mark_recommendation_claimed_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationClaimedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_claimed(request) + + # Establish that the 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_mark_recommendation_claimed_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationClaimedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_claimed(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_mark_recommendation_claimed_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_claimed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_claimed_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_claimed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_claimed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_claimed_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_mark_recommendation_succeeded(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationSucceededRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_succeeded(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_succeeded_from_dict(): + test_mark_recommendation_succeeded(request_type=dict) + + +def test_mark_recommendation_succeeded_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + client.mark_recommendation_succeeded() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationSucceededRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_succeeded(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationSucceededRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_async_from_dict(): + await test_mark_recommendation_succeeded_async(request_type=dict) + + +def test_mark_recommendation_succeeded_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationSucceededRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_succeeded(request) + + # Establish that the 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_mark_recommendation_succeeded_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationSucceededRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_succeeded(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_mark_recommendation_succeeded_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_succeeded( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_succeeded_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_succeeded), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_succeeded( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_succeeded_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_mark_recommendation_failed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationFailedRequest): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + ) + response = client.mark_recommendation_failed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +def test_mark_recommendation_failed_from_dict(): + test_mark_recommendation_failed(request_type=dict) + + +def test_mark_recommendation_failed_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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + client.mark_recommendation_failed() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationFailedRequest): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( + name='name_value', + description='description_value', + recommender_subtype='recommender_subtype_value', + etag='etag_value', + )) + response = await client.mark_recommendation_failed(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recommender_service.MarkRecommendationFailedRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.recommender_subtype == 'recommender_subtype_value' + assert response.etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_async_from_dict(): + await test_mark_recommendation_failed_async(request_type=dict) + + +def test_mark_recommendation_failed_field_headers(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationFailedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + call.return_value = recommendation.Recommendation() + client.mark_recommendation_failed(request) + + # Establish that the 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_mark_recommendation_failed_field_headers_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = recommender_service.MarkRecommendationFailedRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + await client.mark_recommendation_failed(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_mark_recommendation_failed_flattened(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.mark_recommendation_failed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +def test_mark_recommendation_failed_flattened_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_flattened_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.mark_recommendation_failed), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recommendation.Recommendation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.mark_recommendation_failed( + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_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].state_metadata == {'key_value': 'value_value'} + assert args[0].etag == 'etag_value' + + +@pytest.mark.asyncio +async def test_mark_recommendation_failed_flattened_error_async(): + client = RecommenderAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name='name_value', + state_metadata={'key_value': 'value_value'}, + etag='etag_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecommenderClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecommenderGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecommenderGrpcTransport, + ) + +def test_recommender_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_recommender_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_insights', + 'get_insight', + 'mark_insight_accepted', + 'list_recommendations', + 'get_recommendation', + 'mark_recommendation_claimed', + 'mark_recommendation_succeeded', + 'mark_recommendation_failed', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_recommender_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport( + 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_recommender_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport( + 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_recommender_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecommenderTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_recommender_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecommenderClient() + 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_recommender_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + RecommenderClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_recommender_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_recommender_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(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_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.RecommenderGrpcTransport, grpc_helpers), + (transports.RecommenderGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_recommender_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "recommender.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="recommender.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_recommender_host_no_port(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com'), + ) + assert client.transport._host == 'recommender.googleapis.com:443' + + +def test_recommender_host_with_port(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com:8000'), + ) + assert client.transport._host == 'recommender.googleapis.com:8000' + +def test_recommender_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecommenderGrpcTransport( + 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_recommender_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecommenderGrpcAsyncIOTransport( + 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.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) +def test_recommender_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_insight_path(): + project = "squid" + location = "clam" + insight_type = "whelk" + insight = "octopus" + expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) + actual = RecommenderClient.insight_path(project, location, insight_type, insight) + assert expected == actual + + +def test_parse_insight_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "insight_type": "cuttlefish", + "insight": "mussel", + } + path = RecommenderClient.insight_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_insight_path(path) + assert expected == actual + +def test_insight_type_path(): + project = "winkle" + location = "nautilus" + insight_type = "scallop" + expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) + actual = RecommenderClient.insight_type_path(project, location, insight_type) + assert expected == actual + + +def test_parse_insight_type_path(): + expected = { + "project": "abalone", + "location": "squid", + "insight_type": "clam", + } + path = RecommenderClient.insight_type_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_insight_type_path(path) + assert expected == actual + +def test_recommendation_path(): + project = "whelk" + location = "octopus" + recommender = "oyster" + recommendation = "nudibranch" + expected = "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) + actual = RecommenderClient.recommendation_path(project, location, recommender, recommendation) + assert expected == actual + + +def test_parse_recommendation_path(): + expected = { + "project": "cuttlefish", + "location": "mussel", + "recommender": "winkle", + "recommendation": "nautilus", + } + path = RecommenderClient.recommendation_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_recommendation_path(path) + assert expected == actual + +def test_recommender_path(): + project = "scallop" + location = "abalone" + recommender = "squid" + expected = "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) + actual = RecommenderClient.recommender_path(project, location, recommender) + assert expected == actual + + +def test_parse_recommender_path(): + expected = { + "project": "clam", + "location": "whelk", + "recommender": "octopus", + } + path = RecommenderClient.recommender_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_recommender_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = RecommenderClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = RecommenderClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format(folder=folder, ) + actual = RecommenderClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = RecommenderClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format(organization=organization, ) + actual = RecommenderClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = RecommenderClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format(project=project, ) + actual = RecommenderClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = RecommenderClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = RecommenderClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = RecommenderClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = RecommenderClient.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.RecommenderTransport, '_prep_wrapped_messages') as prep: + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.RecommenderTransport, '_prep_wrapped_messages') as prep: + transport_class = RecommenderClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From f13c49c68a1381ed958192abb041d9970d6fe833 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:01:42 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md --- .../services/recommender/client.py | 4 + .../services/recommender/client.py | 4 + owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 -- owl-bot-staging/v1/docs/index.rst | 7 - .../v1/docs/recommender_v1/recommender.rst | 10 - .../v1/docs/recommender_v1/services.rst | 6 - .../v1/docs/recommender_v1/types.rst | 7 - .../v1/google/cloud/recommender/__init__.py | 63 - .../v1/google/cloud/recommender/py.typed | 2 - .../google/cloud/recommender_v1/__init__.py | 64 - .../cloud/recommender_v1/gapic_metadata.json | 103 - .../v1/google/cloud/recommender_v1/py.typed | 2 - .../cloud/recommender_v1/services/__init__.py | 15 - .../services/recommender/__init__.py | 22 - .../services/recommender/async_client.py | 993 ----- .../services/recommender/client.py | 1179 ------ .../services/recommender/pagers.py | 264 -- .../recommender/transports/__init__.py | 33 - .../services/recommender/transports/base.py | 296 -- .../services/recommender/transports/grpc.py | 482 --- .../recommender/transports/grpc_asyncio.py | 486 --- .../cloud/recommender_v1/types/__init__.py | 64 - .../cloud/recommender_v1/types/insight.py | 170 - .../recommender_v1/types/recommendation.py | 420 -- .../types/recommender_service.py | 335 -- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../scripts/fixup_recommender_v1_keywords.py | 183 - owl-bot-staging/v1/setup.py | 54 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/recommender_v1/__init__.py | 16 - .../gapic/recommender_v1/test_recommender.py | 3377 ----------------- owl-bot-staging/v1beta1/.coveragerc | 17 - owl-bot-staging/v1beta1/MANIFEST.in | 2 - owl-bot-staging/v1beta1/README.rst | 49 - owl-bot-staging/v1beta1/docs/conf.py | 376 -- owl-bot-staging/v1beta1/docs/index.rst | 7 - .../docs/recommender_v1beta1/recommender.rst | 10 - .../docs/recommender_v1beta1/services.rst | 6 - .../docs/recommender_v1beta1/types.rst | 7 - .../google/cloud/recommender/__init__.py | 63 - .../v1beta1/google/cloud/recommender/py.typed | 2 - .../cloud/recommender_v1beta1/__init__.py | 64 - .../recommender_v1beta1/gapic_metadata.json | 103 - .../google/cloud/recommender_v1beta1/py.typed | 2 - .../recommender_v1beta1/services/__init__.py | 15 - .../services/recommender/__init__.py | 22 - .../services/recommender/async_client.py | 993 ----- .../services/recommender/client.py | 1179 ------ .../services/recommender/pagers.py | 264 -- .../recommender/transports/__init__.py | 33 - .../services/recommender/transports/base.py | 296 -- .../services/recommender/transports/grpc.py | 482 --- .../recommender/transports/grpc_asyncio.py | 486 --- .../recommender_v1beta1/types/__init__.py | 64 - .../recommender_v1beta1/types/insight.py | 170 - .../types/recommendation.py | 420 -- .../types/recommender_service.py | 335 -- owl-bot-staging/v1beta1/mypy.ini | 3 - owl-bot-staging/v1beta1/noxfile.py | 132 - .../fixup_recommender_v1beta1_keywords.py | 183 - owl-bot-staging/v1beta1/setup.py | 54 - owl-bot-staging/v1beta1/tests/__init__.py | 16 - .../v1beta1/tests/unit/__init__.py | 16 - .../v1beta1/tests/unit/gapic/__init__.py | 16 - .../gapic/recommender_v1beta1/__init__.py | 16 - .../recommender_v1beta1/test_recommender.py | 3377 ----------------- .../gapic/recommender_v1/test_recommender.py | 29 +- .../recommender_v1beta1/test_recommender.py | 29 +- 74 files changed, 44 insertions(+), 18582 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/docs/recommender_v1/recommender.rst delete mode 100644 owl-bot-staging/v1/docs/recommender_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/recommender_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/recommender/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py delete mode 100644 owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/recommender_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py delete mode 100644 owl-bot-staging/v1beta1/.coveragerc delete mode 100644 owl-bot-staging/v1beta1/MANIFEST.in delete mode 100644 owl-bot-staging/v1beta1/README.rst delete mode 100644 owl-bot-staging/v1beta1/docs/conf.py delete mode 100644 owl-bot-staging/v1beta1/docs/index.rst delete mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst delete mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst delete mode 100644 owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender/py.typed delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py delete mode 100644 owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py delete mode 100644 owl-bot-staging/v1beta1/mypy.ini delete mode 100644 owl-bot-staging/v1beta1/noxfile.py delete mode 100644 owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py delete mode 100644 owl-bot-staging/v1beta1/setup.py delete mode 100644 owl-bot-staging/v1beta1/tests/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py delete mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py diff --git a/google/cloud/recommender_v1/services/recommender/client.py b/google/cloud/recommender_v1/services/recommender/client.py index ae52060..d1f83a5 100644 --- a/google/cloud/recommender_v1/services/recommender/client.py +++ b/google/cloud/recommender_v1/services/recommender/client.py @@ -410,6 +410,10 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), ) def list_insights( diff --git a/google/cloud/recommender_v1beta1/services/recommender/client.py b/google/cloud/recommender_v1beta1/services/recommender/client.py index 5236d0a..fe469ad 100644 --- a/google/cloud/recommender_v1beta1/services/recommender/client.py +++ b/google/cloud/recommender_v1beta1/services/recommender/client.py @@ -410,6 +410,10 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), ) def list_insights( diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index cacc3bc..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/recommender/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 101ac0e..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/recommender *.py -recursive-include google/cloud/recommender_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 3728662..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Recommender 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 Recommender API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 49094fc..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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-recommender 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-recommender" -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-recommender-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-recommender.tex", - u"google-cloud-recommender 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-recommender", - u"Google Cloud Recommender 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-recommender", - u"google-cloud-recommender Documentation", - author, - "google-cloud-recommender", - "GAPIC library for Google Cloud Recommender 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 deleted file mode 100644 index 9da75ac..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - recommender_v1/services - recommender_v1/types diff --git a/owl-bot-staging/v1/docs/recommender_v1/recommender.rst b/owl-bot-staging/v1/docs/recommender_v1/recommender.rst deleted file mode 100644 index c15b52f..0000000 --- a/owl-bot-staging/v1/docs/recommender_v1/recommender.rst +++ /dev/null @@ -1,10 +0,0 @@ -Recommender ------------------------------ - -.. automodule:: google.cloud.recommender_v1.services.recommender - :members: - :inherited-members: - -.. automodule:: google.cloud.recommender_v1.services.recommender.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/recommender_v1/services.rst b/owl-bot-staging/v1/docs/recommender_v1/services.rst deleted file mode 100644 index d23296a..0000000 --- a/owl-bot-staging/v1/docs/recommender_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Recommender v1 API -============================================ -.. toctree:: - :maxdepth: 2 - - recommender diff --git a/owl-bot-staging/v1/docs/recommender_v1/types.rst b/owl-bot-staging/v1/docs/recommender_v1/types.rst deleted file mode 100644 index dd13661..0000000 --- a/owl-bot-staging/v1/docs/recommender_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Recommender v1 API -========================================= - -.. automodule:: google.cloud.recommender_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recommender/__init__.py b/owl-bot-staging/v1/google/cloud/recommender/__init__.py deleted file mode 100644 index 61432d2..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender/__init__.py +++ /dev/null @@ -1,63 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender_v1.services.recommender.client import RecommenderClient -from google.cloud.recommender_v1.services.recommender.async_client import RecommenderAsyncClient - -from google.cloud.recommender_v1.types.insight import Insight -from google.cloud.recommender_v1.types.insight import InsightStateInfo -from google.cloud.recommender_v1.types.recommendation import CostProjection -from google.cloud.recommender_v1.types.recommendation import Impact -from google.cloud.recommender_v1.types.recommendation import Operation -from google.cloud.recommender_v1.types.recommendation import OperationGroup -from google.cloud.recommender_v1.types.recommendation import Recommendation -from google.cloud.recommender_v1.types.recommendation import RecommendationContent -from google.cloud.recommender_v1.types.recommendation import RecommendationStateInfo -from google.cloud.recommender_v1.types.recommendation import ValueMatcher -from google.cloud.recommender_v1.types.recommender_service import GetInsightRequest -from google.cloud.recommender_v1.types.recommender_service import GetRecommendationRequest -from google.cloud.recommender_v1.types.recommender_service import ListInsightsRequest -from google.cloud.recommender_v1.types.recommender_service import ListInsightsResponse -from google.cloud.recommender_v1.types.recommender_service import ListRecommendationsRequest -from google.cloud.recommender_v1.types.recommender_service import ListRecommendationsResponse -from google.cloud.recommender_v1.types.recommender_service import MarkInsightAcceptedRequest -from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationClaimedRequest -from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationFailedRequest -from google.cloud.recommender_v1.types.recommender_service import MarkRecommendationSucceededRequest - -__all__ = ('RecommenderClient', - 'RecommenderAsyncClient', - 'Insight', - 'InsightStateInfo', - 'CostProjection', - 'Impact', - 'Operation', - 'OperationGroup', - 'Recommendation', - 'RecommendationContent', - 'RecommendationStateInfo', - 'ValueMatcher', - 'GetInsightRequest', - 'GetRecommendationRequest', - 'ListInsightsRequest', - 'ListInsightsResponse', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'MarkInsightAcceptedRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationFailedRequest', - 'MarkRecommendationSucceededRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender/py.typed b/owl-bot-staging/v1/google/cloud/recommender/py.typed deleted file mode 100644 index f9105be..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py deleted file mode 100644 index 8bc995e..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/__init__.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender import RecommenderClient -from .services.recommender import RecommenderAsyncClient - -from .types.insight import Insight -from .types.insight import InsightStateInfo -from .types.recommendation import CostProjection -from .types.recommendation import Impact -from .types.recommendation import Operation -from .types.recommendation import OperationGroup -from .types.recommendation import Recommendation -from .types.recommendation import RecommendationContent -from .types.recommendation import RecommendationStateInfo -from .types.recommendation import ValueMatcher -from .types.recommender_service import GetInsightRequest -from .types.recommender_service import GetRecommendationRequest -from .types.recommender_service import ListInsightsRequest -from .types.recommender_service import ListInsightsResponse -from .types.recommender_service import ListRecommendationsRequest -from .types.recommender_service import ListRecommendationsResponse -from .types.recommender_service import MarkInsightAcceptedRequest -from .types.recommender_service import MarkRecommendationClaimedRequest -from .types.recommender_service import MarkRecommendationFailedRequest -from .types.recommender_service import MarkRecommendationSucceededRequest - -__all__ = ( - 'RecommenderAsyncClient', -'CostProjection', -'GetInsightRequest', -'GetRecommendationRequest', -'Impact', -'Insight', -'InsightStateInfo', -'ListInsightsRequest', -'ListInsightsResponse', -'ListRecommendationsRequest', -'ListRecommendationsResponse', -'MarkInsightAcceptedRequest', -'MarkRecommendationClaimedRequest', -'MarkRecommendationFailedRequest', -'MarkRecommendationSucceededRequest', -'Operation', -'OperationGroup', -'Recommendation', -'RecommendationContent', -'RecommendationStateInfo', -'RecommenderClient', -'ValueMatcher', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json deleted file mode 100644 index b1bbf08..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/gapic_metadata.json +++ /dev/null @@ -1,103 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.recommender_v1", - "protoPackage": "google.cloud.recommender.v1", - "schema": "1.0", - "services": { - "Recommender": { - "clients": { - "grpc": { - "libraryClient": "RecommenderClient", - "rpcs": { - "GetInsight": { - "methods": [ - "get_insight" - ] - }, - "GetRecommendation": { - "methods": [ - "get_recommendation" - ] - }, - "ListInsights": { - "methods": [ - "list_insights" - ] - }, - "ListRecommendations": { - "methods": [ - "list_recommendations" - ] - }, - "MarkInsightAccepted": { - "methods": [ - "mark_insight_accepted" - ] - }, - "MarkRecommendationClaimed": { - "methods": [ - "mark_recommendation_claimed" - ] - }, - "MarkRecommendationFailed": { - "methods": [ - "mark_recommendation_failed" - ] - }, - "MarkRecommendationSucceeded": { - "methods": [ - "mark_recommendation_succeeded" - ] - } - } - }, - "grpc-async": { - "libraryClient": "RecommenderAsyncClient", - "rpcs": { - "GetInsight": { - "methods": [ - "get_insight" - ] - }, - "GetRecommendation": { - "methods": [ - "get_recommendation" - ] - }, - "ListInsights": { - "methods": [ - "list_insights" - ] - }, - "ListRecommendations": { - "methods": [ - "list_recommendations" - ] - }, - "MarkInsightAccepted": { - "methods": [ - "mark_insight_accepted" - ] - }, - "MarkRecommendationClaimed": { - "methods": [ - "mark_recommendation_claimed" - ] - }, - "MarkRecommendationFailed": { - "methods": [ - "mark_recommendation_failed" - ] - }, - "MarkRecommendationSucceeded": { - "methods": [ - "mark_recommendation_succeeded" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed b/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed deleted file mode 100644 index f9105be..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/recommender_v1/services/recommender/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__init__.py deleted file mode 100644 index 09e2c3c..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 RecommenderClient -from .async_client import RecommenderAsyncClient - -__all__ = ( - 'RecommenderClient', - 'RecommenderAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py deleted file mode 100644 index 8e40bbb..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/async_client.py +++ /dev/null @@ -1,993 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1.services.recommender import pagers -from google.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport -from .client import RecommenderClient - - -class RecommenderAsyncClient: - """Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - """ - - _client: RecommenderClient - - DEFAULT_ENDPOINT = RecommenderClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = RecommenderClient.DEFAULT_MTLS_ENDPOINT - - insight_path = staticmethod(RecommenderClient.insight_path) - parse_insight_path = staticmethod(RecommenderClient.parse_insight_path) - insight_type_path = staticmethod(RecommenderClient.insight_type_path) - parse_insight_type_path = staticmethod(RecommenderClient.parse_insight_type_path) - recommendation_path = staticmethod(RecommenderClient.recommendation_path) - parse_recommendation_path = staticmethod(RecommenderClient.parse_recommendation_path) - recommender_path = staticmethod(RecommenderClient.recommender_path) - parse_recommender_path = staticmethod(RecommenderClient.parse_recommender_path) - common_billing_account_path = staticmethod(RecommenderClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(RecommenderClient.parse_common_billing_account_path) - common_folder_path = staticmethod(RecommenderClient.common_folder_path) - parse_common_folder_path = staticmethod(RecommenderClient.parse_common_folder_path) - common_organization_path = staticmethod(RecommenderClient.common_organization_path) - parse_common_organization_path = staticmethod(RecommenderClient.parse_common_organization_path) - common_project_path = staticmethod(RecommenderClient.common_project_path) - parse_common_project_path = staticmethod(RecommenderClient.parse_common_project_path) - common_location_path = staticmethod(RecommenderClient.common_location_path) - parse_common_location_path = staticmethod(RecommenderClient.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: - RecommenderAsyncClient: The constructed client. - """ - return RecommenderClient.from_service_account_info.__func__(RecommenderAsyncClient, 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: - RecommenderAsyncClient: The constructed client. - """ - return RecommenderClient.from_service_account_file.__func__(RecommenderAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> RecommenderTransport: - """Returns the transport used by the client instance. - - Returns: - RecommenderTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(RecommenderClient).get_transport_class, type(RecommenderClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, RecommenderTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recommender 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, ~.RecommenderTransport]): 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 = RecommenderClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def list_insights(self, - request: recommender_service.ListInsightsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListInsightsAsyncPager: - r"""Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Args: - request (:class:`google.cloud.recommender_v1.types.ListInsightsRequest`): - The request object. Request for the `ListInsights` - method. - parent (:class:`str`): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ - INSIGHT_TYPE_ID refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types.) - - 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.recommender_v1.services.recommender.pagers.ListInsightsAsyncPager: - Response to the ListInsights method. - - 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 = recommender_service.ListInsightsRequest(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_insights, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("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.ListInsightsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_insight(self, - request: recommender_service.GetInsightRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Args: - request (:class:`google.cloud.recommender_v1.types.GetInsightRequest`): - The request object. Request to the `GetInsight` method. - name (:class:`str`): - Required. Name of the insight. - 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.recommender_v1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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 = recommender_service.GetInsightRequest(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_insight, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def mark_insight_accepted(self, - request: recommender_service.MarkInsightAcceptedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Args: - request (:class:`google.cloud.recommender_v1.types.MarkInsightAcceptedRequest`): - The request object. Request for the - `MarkInsightAccepted` method. - name (:class:`str`): - Required. Name of the insight. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]`): - Optional. State properties user wish to include with - this state. Full replace of the current state_metadata. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the Insight. - Provides optimistic locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkInsightAcceptedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_insight_accepted, - 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_recommendations(self, - request: recommender_service.ListRecommendationsRequest = None, - *, - parent: str = None, - filter: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRecommendationsAsyncPager: - r"""Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1.types.ListRecommendationsRequest`): - The request object. Request for the - `ListRecommendations` method. - parent (:class:`str`): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (:class:`str`): - Filter expression to restrict the recommendations - returned. Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or - state_info.state:"FAILED" - - This corresponds to the ``filter`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.services.recommender.pagers.ListRecommendationsAsyncPager: - Response to the ListRecommendations method. - - 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, filter]) - if request is 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 = recommender_service.ListRecommendationsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # 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_recommendations, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("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.ListRecommendationsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_recommendation(self, - request: recommender_service.GetRecommendationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1.types.GetRecommendationRequest`): - The request object. Request to the `GetRecommendation` - method. - name (:class:`str`): - Required. Name of the recommendation. - 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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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 = recommender_service.GetRecommendationRequest(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_recommendation, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def mark_recommendation_claimed(self, - request: recommender_service.MarkRecommendationClaimedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest`): - The request object. Request for the - `MarkRecommendationClaimed` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationClaimedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_claimed, - 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 mark_recommendation_succeeded(self, - request: recommender_service.MarkRecommendationSucceededRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest`): - The request object. Request for the - `MarkRecommendationSucceeded` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationSucceededRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_succeeded, - 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 mark_recommendation_failed(self, - request: recommender_service.MarkRecommendationFailedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1.types.MarkRecommendationFailedRequest`): - The request object. Request for the - `MarkRecommendationFailed` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationFailedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_failed, - 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 - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recommender", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecommenderAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py deleted file mode 100644 index a304aad..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/client.py +++ /dev/null @@ -1,1179 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 as core_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 as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1.services.recommender import pagers -from google.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import RecommenderGrpcTransport -from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport - - -class RecommenderClientMeta(type): - """Metaclass for the Recommender 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[RecommenderTransport]] - _transport_registry["grpc"] = RecommenderGrpcTransport - _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[RecommenderTransport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class RecommenderClient(metaclass=RecommenderClientMeta): - """Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "recommender.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: - RecommenderClient: 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: - RecommenderClient: 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) -> RecommenderTransport: - """Returns the transport used by the client instance. - - Returns: - RecommenderTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def insight_path(project: str,location: str,insight_type: str,insight: str,) -> str: - """Returns a fully-qualified insight string.""" - return "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) - - @staticmethod - def parse_insight_path(path: str) -> Dict[str,str]: - """Parses a insight path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)/insights/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def insight_type_path(project: str,location: str,insight_type: str,) -> str: - """Returns a fully-qualified insight_type string.""" - return "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) - - @staticmethod - def parse_insight_type_path(path: str) -> Dict[str,str]: - """Parses a insight_type path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def recommendation_path(project: str,location: str,recommender: str,recommendation: str,) -> str: - """Returns a fully-qualified recommendation string.""" - return "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) - - @staticmethod - def parse_recommendation_path(path: str) -> Dict[str,str]: - """Parses a recommendation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)/recommendations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def recommender_path(project: str,location: str,recommender: str,) -> str: - """Returns a fully-qualified recommender string.""" - return "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) - - @staticmethod - def parse_recommender_path(path: str) -> Dict[str,str]: - """Parses a recommender path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, RecommenderTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recommender 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, RecommenderTransport]): 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() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = 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": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = 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, RecommenderTransport): - # transport is a RecommenderTransport 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, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), - ) - - def list_insights(self, - request: recommender_service.ListInsightsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListInsightsPager: - r"""Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Args: - request (google.cloud.recommender_v1.types.ListInsightsRequest): - The request object. Request for the `ListInsights` - method. - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ - INSIGHT_TYPE_ID refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types.) - - 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.recommender_v1.services.recommender.pagers.ListInsightsPager: - Response to the ListInsights method. - - 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 recommender_service.ListInsightsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.ListInsightsRequest): - request = recommender_service.ListInsightsRequest(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_insights] - - # 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.ListInsightsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_insight(self, - request: recommender_service.GetInsightRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Args: - request (google.cloud.recommender_v1.types.GetInsightRequest): - The request object. Request to the `GetInsight` method. - name (str): - Required. Name of the insight. - 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.recommender_v1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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 recommender_service.GetInsightRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.GetInsightRequest): - request = recommender_service.GetInsightRequest(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_insight] - - # 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 mark_insight_accepted(self, - request: recommender_service.MarkInsightAcceptedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Args: - request (google.cloud.recommender_v1.types.MarkInsightAcceptedRequest): - The request object. Request for the - `MarkInsightAccepted` method. - name (str): - Required. Name of the insight. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): - Optional. State properties user wish to include with - this state. Full replace of the current state_metadata. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the Insight. - Provides optimistic locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkInsightAcceptedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkInsightAcceptedRequest): - request = recommender_service.MarkInsightAcceptedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_insight_accepted] - - # 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_recommendations(self, - request: recommender_service.ListRecommendationsRequest = None, - *, - parent: str = None, - filter: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRecommendationsPager: - r"""Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Args: - request (google.cloud.recommender_v1.types.ListRecommendationsRequest): - The request object. Request for the - `ListRecommendations` method. - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (str): - Filter expression to restrict the recommendations - returned. Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or - state_info.state:"FAILED" - - This corresponds to the ``filter`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.services.recommender.pagers.ListRecommendationsPager: - Response to the ListRecommendations method. - - 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, filter]) - if request is 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 recommender_service.ListRecommendationsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.ListRecommendationsRequest): - request = recommender_service.ListRecommendationsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_recommendations] - - # 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.ListRecommendationsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_recommendation(self, - request: recommender_service.GetRecommendationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Args: - request (google.cloud.recommender_v1.types.GetRecommendationRequest): - The request object. Request to the `GetRecommendation` - method. - name (str): - Required. Name of the recommendation. - 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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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 recommender_service.GetRecommendationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.GetRecommendationRequest): - request = recommender_service.GetRecommendationRequest(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_recommendation] - - # 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 mark_recommendation_claimed(self, - request: recommender_service.MarkRecommendationClaimedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest): - The request object. Request for the - `MarkRecommendationClaimed` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationClaimedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationClaimedRequest): - request = recommender_service.MarkRecommendationClaimedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_claimed] - - # 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 mark_recommendation_succeeded(self, - request: recommender_service.MarkRecommendationSucceededRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest): - The request object. Request for the - `MarkRecommendationSucceeded` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationSucceededRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationSucceededRequest): - request = recommender_service.MarkRecommendationSucceededRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_succeeded] - - # 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 mark_recommendation_failed(self, - request: recommender_service.MarkRecommendationFailedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1.types.MarkRecommendationFailedRequest): - The request object. Request for the - `MarkRecommendationFailed` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationFailedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationFailedRequest): - request = recommender_service.MarkRecommendationFailedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_failed] - - # 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 - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recommender", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecommenderClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py deleted file mode 100644 index 505f260..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/pagers.py +++ /dev/null @@ -1,264 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service - - -class ListInsightsPager: - """A pager for iterating through ``list_insights`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1.types.ListInsightsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``insights`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListInsights`` requests and continue to iterate - through the ``insights`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1.types.ListInsightsResponse` - 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[..., recommender_service.ListInsightsResponse], - request: recommender_service.ListInsightsRequest, - response: recommender_service.ListInsightsResponse, - *, - 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.recommender_v1.types.ListInsightsRequest): - The initial request object. - response (google.cloud.recommender_v1.types.ListInsightsResponse): - 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 = recommender_service.ListInsightsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[recommender_service.ListInsightsResponse]: - 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[insight.Insight]: - for page in self.pages: - yield from page.insights - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListInsightsAsyncPager: - """A pager for iterating through ``list_insights`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1.types.ListInsightsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``insights`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListInsights`` requests and continue to iterate - through the ``insights`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1.types.ListInsightsResponse` - 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[recommender_service.ListInsightsResponse]], - request: recommender_service.ListInsightsRequest, - response: recommender_service.ListInsightsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recommender_v1.types.ListInsightsRequest): - The initial request object. - response (google.cloud.recommender_v1.types.ListInsightsResponse): - 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 = recommender_service.ListInsightsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[recommender_service.ListInsightsResponse]: - 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[insight.Insight]: - async def async_generator(): - async for page in self.pages: - for response in page.insights: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRecommendationsPager: - """A pager for iterating through ``list_recommendations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``recommendations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRecommendations`` requests and continue to iterate - through the ``recommendations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` - 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[..., recommender_service.ListRecommendationsResponse], - request: recommender_service.ListRecommendationsRequest, - response: recommender_service.ListRecommendationsResponse, - *, - 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.recommender_v1.types.ListRecommendationsRequest): - The initial request object. - response (google.cloud.recommender_v1.types.ListRecommendationsResponse): - 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 = recommender_service.ListRecommendationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[recommender_service.ListRecommendationsResponse]: - 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[recommendation.Recommendation]: - for page in self.pages: - yield from page.recommendations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRecommendationsAsyncPager: - """A pager for iterating through ``list_recommendations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``recommendations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRecommendations`` requests and continue to iterate - through the ``recommendations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1.types.ListRecommendationsResponse` - 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[recommender_service.ListRecommendationsResponse]], - request: recommender_service.ListRecommendationsRequest, - response: recommender_service.ListRecommendationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recommender_v1.types.ListRecommendationsRequest): - The initial request object. - response (google.cloud.recommender_v1.types.ListRecommendationsResponse): - 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 = recommender_service.ListRecommendationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[recommender_service.ListRecommendationsResponse]: - 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[recommendation.Recommendation]: - async def async_generator(): - async for page in self.pages: - for response in page.recommendations: - 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/recommender_v1/services/recommender/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/__init__.py deleted file mode 100644 index 18245b5..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 RecommenderTransport -from .grpc import RecommenderGrpcTransport -from .grpc_asyncio import RecommenderGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] -_transport_registry['grpc'] = RecommenderGrpcTransport -_transport_registry['grpc_asyncio'] = RecommenderGrpcAsyncIOTransport - -__all__ = ( - 'RecommenderTransport', - 'RecommenderGrpcTransport', - 'RecommenderGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py deleted file mode 100644 index c2da68d..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/base.py +++ /dev/null @@ -1,296 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-recommender', - ).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 = google.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 - - -class RecommenderTransport(abc.ABC): - """Abstract transport class for Recommender.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'recommender.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # 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 - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is 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 - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.list_insights: gapic_v1.method.wrap_method( - self.list_insights, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_insight: gapic_v1.method.wrap_method( - self.get_insight, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.mark_insight_accepted: gapic_v1.method.wrap_method( - self.mark_insight_accepted, - default_timeout=60.0, - client_info=client_info, - ), - self.list_recommendations: gapic_v1.method.wrap_method( - self.list_recommendations, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_recommendation: gapic_v1.method.wrap_method( - self.get_recommendation, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_claimed: gapic_v1.method.wrap_method( - self.mark_recommendation_claimed, - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_succeeded: gapic_v1.method.wrap_method( - self.mark_recommendation_succeeded, - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_failed: gapic_v1.method.wrap_method( - self.mark_recommendation_failed, - default_timeout=60.0, - client_info=client_info, - ), - } - - @property - def list_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - Union[ - recommender_service.ListInsightsResponse, - Awaitable[recommender_service.ListInsightsResponse] - ]]: - raise NotImplementedError() - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - Union[ - insight.Insight, - Awaitable[insight.Insight] - ]]: - raise NotImplementedError() - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - Union[ - insight.Insight, - Awaitable[insight.Insight] - ]]: - raise NotImplementedError() - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - Union[ - recommender_service.ListRecommendationsResponse, - Awaitable[recommender_service.ListRecommendationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'RecommenderTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py deleted file mode 100644 index 844527e..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc.py +++ /dev/null @@ -1,482 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service -from .base import RecommenderTransport, DEFAULT_CLIENT_INFO - - -class RecommenderGrpcTransport(RecommenderTransport): - """gRPC backend transport for Recommender. - - Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - - 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 = 'recommender.googleapis.com', - credentials: ga_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, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - 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 = 'recommender.googleapis.com', - credentials: ga_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. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def list_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - recommender_service.ListInsightsResponse]: - r"""Return a callable for the list insights method over gRPC. - - Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Returns: - Callable[[~.ListInsightsRequest], - ~.ListInsightsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insights' not in self._stubs: - self._stubs['list_insights'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/ListInsights', - request_serializer=recommender_service.ListInsightsRequest.serialize, - response_deserializer=recommender_service.ListInsightsResponse.deserialize, - ) - return self._stubs['list_insights'] - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - insight.Insight]: - r"""Return a callable for the get insight method over gRPC. - - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Returns: - Callable[[~.GetInsightRequest], - ~.Insight]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insight' not in self._stubs: - self._stubs['get_insight'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/GetInsight', - request_serializer=recommender_service.GetInsightRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['get_insight'] - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - insight.Insight]: - r"""Return a callable for the mark insight accepted method over gRPC. - - Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Returns: - Callable[[~.MarkInsightAcceptedRequest], - ~.Insight]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_insight_accepted' not in self._stubs: - self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkInsightAccepted', - request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['mark_insight_accepted'] - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - recommender_service.ListRecommendationsResponse]: - r"""Return a callable for the list recommendations method over gRPC. - - Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Returns: - Callable[[~.ListRecommendationsRequest], - ~.ListRecommendationsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendations' not in self._stubs: - self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/ListRecommendations', - request_serializer=recommender_service.ListRecommendationsRequest.serialize, - response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, - ) - return self._stubs['list_recommendations'] - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - recommendation.Recommendation]: - r"""Return a callable for the get recommendation method over gRPC. - - Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Returns: - Callable[[~.GetRecommendationRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendation' not in self._stubs: - self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/GetRecommendation', - request_serializer=recommender_service.GetRecommendationRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['get_recommendation'] - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation claimed method over gRPC. - - Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationClaimedRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_claimed' not in self._stubs: - self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationClaimed', - request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_claimed'] - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation succeeded method over gRPC. - - Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationSucceededRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_succeeded' not in self._stubs: - self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationSucceeded', - request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_succeeded'] - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation failed method over gRPC. - - Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationFailedRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_failed' not in self._stubs: - self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationFailed', - request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_failed'] - - -__all__ = ( - 'RecommenderGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py deleted file mode 100644 index 91db556..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py +++ /dev/null @@ -1,486 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.auth import credentials as ga_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.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service -from .base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .grpc import RecommenderGrpcTransport - - -class RecommenderGrpcAsyncIOTransport(RecommenderTransport): - """gRPC AsyncIO backend transport for Recommender. - - Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - - 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 = 'recommender.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'recommender.googleapis.com', - credentials: ga_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, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - 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_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - Awaitable[recommender_service.ListInsightsResponse]]: - r"""Return a callable for the list insights method over gRPC. - - Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Returns: - Callable[[~.ListInsightsRequest], - Awaitable[~.ListInsightsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insights' not in self._stubs: - self._stubs['list_insights'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/ListInsights', - request_serializer=recommender_service.ListInsightsRequest.serialize, - response_deserializer=recommender_service.ListInsightsResponse.deserialize, - ) - return self._stubs['list_insights'] - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - Awaitable[insight.Insight]]: - r"""Return a callable for the get insight method over gRPC. - - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Returns: - Callable[[~.GetInsightRequest], - Awaitable[~.Insight]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insight' not in self._stubs: - self._stubs['get_insight'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/GetInsight', - request_serializer=recommender_service.GetInsightRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['get_insight'] - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - Awaitable[insight.Insight]]: - r"""Return a callable for the mark insight accepted method over gRPC. - - Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Returns: - Callable[[~.MarkInsightAcceptedRequest], - Awaitable[~.Insight]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_insight_accepted' not in self._stubs: - self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkInsightAccepted', - request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['mark_insight_accepted'] - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - Awaitable[recommender_service.ListRecommendationsResponse]]: - r"""Return a callable for the list recommendations method over gRPC. - - Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Returns: - Callable[[~.ListRecommendationsRequest], - Awaitable[~.ListRecommendationsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendations' not in self._stubs: - self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/ListRecommendations', - request_serializer=recommender_service.ListRecommendationsRequest.serialize, - response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, - ) - return self._stubs['list_recommendations'] - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the get recommendation method over gRPC. - - Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Returns: - Callable[[~.GetRecommendationRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendation' not in self._stubs: - self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/GetRecommendation', - request_serializer=recommender_service.GetRecommendationRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['get_recommendation'] - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation claimed method over gRPC. - - Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationClaimedRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_claimed' not in self._stubs: - self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationClaimed', - request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_claimed'] - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation succeeded method over gRPC. - - Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationSucceededRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_succeeded' not in self._stubs: - self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationSucceeded', - request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_succeeded'] - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation failed method over gRPC. - - Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationFailedRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_failed' not in self._stubs: - self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1.Recommender/MarkRecommendationFailed', - request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_failed'] - - -__all__ = ( - 'RecommenderGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py deleted file mode 100644 index 1238196..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/types/__init__.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 .insight import ( - Insight, - InsightStateInfo, -) -from .recommendation import ( - CostProjection, - Impact, - Operation, - OperationGroup, - Recommendation, - RecommendationContent, - RecommendationStateInfo, - ValueMatcher, -) -from .recommender_service import ( - GetInsightRequest, - GetRecommendationRequest, - ListInsightsRequest, - ListInsightsResponse, - ListRecommendationsRequest, - ListRecommendationsResponse, - MarkInsightAcceptedRequest, - MarkRecommendationClaimedRequest, - MarkRecommendationFailedRequest, - MarkRecommendationSucceededRequest, -) - -__all__ = ( - 'Insight', - 'InsightStateInfo', - 'CostProjection', - 'Impact', - 'Operation', - 'OperationGroup', - 'Recommendation', - 'RecommendationContent', - 'RecommendationStateInfo', - 'ValueMatcher', - 'GetInsightRequest', - 'GetRecommendationRequest', - 'ListInsightsRequest', - 'ListInsightsResponse', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'MarkInsightAcceptedRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationFailedRequest', - 'MarkRecommendationSucceededRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py deleted file mode 100644 index df63adb..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/types/insight.py +++ /dev/null @@ -1,170 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1', - manifest={ - 'Insight', - 'InsightStateInfo', - }, -) - - -class Insight(proto.Message): - r"""An insight along with the information used to derive the - insight. The insight may have associated recomendations as well. - - Attributes: - name (str): - Name of the insight. - description (str): - Free-form human readable summary in English. - The maximum length is 500 characters. - target_resources (Sequence[str]): - Fully qualified resource names that this - insight is targeting. - insight_subtype (str): - Insight subtype. Insight content schema will - be stable for a given subtype. - content (google.protobuf.struct_pb2.Struct): - A struct of custom fields to explain the - insight. Example: "grantedPermissionsCount": - "1000". - last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): - Timestamp of the latest data used to generate - the insight. - observation_period (google.protobuf.duration_pb2.Duration): - Observation period that led to the insight. The source data - used to generate the insight ends at last_refresh_time and - begins at (last_refresh_time - observation_period). - state_info (google.cloud.recommender_v1.types.InsightStateInfo): - Information state and metadata. - category (google.cloud.recommender_v1.types.Insight.Category): - Category being targeted by the insight. - etag (str): - Fingerprint of the Insight. Provides - optimistic locking when updating states. - associated_recommendations (Sequence[google.cloud.recommender_v1.types.Insight.RecommendationReference]): - Recommendations derived from this insight. - """ - class Category(proto.Enum): - r"""Insight category.""" - CATEGORY_UNSPECIFIED = 0 - COST = 1 - SECURITY = 2 - PERFORMANCE = 3 - MANAGEABILITY = 4 - - class RecommendationReference(proto.Message): - r"""Reference to an associated recommendation. - Attributes: - recommendation (str): - Recommendation resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] - """ - - recommendation = proto.Field( - proto.STRING, - number=1, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - description = proto.Field( - proto.STRING, - number=2, - ) - target_resources = proto.RepeatedField( - proto.STRING, - number=9, - ) - insight_subtype = proto.Field( - proto.STRING, - number=10, - ) - content = proto.Field( - proto.MESSAGE, - number=3, - message=struct_pb2.Struct, - ) - last_refresh_time = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - observation_period = proto.Field( - proto.MESSAGE, - number=5, - message=duration_pb2.Duration, - ) - state_info = proto.Field( - proto.MESSAGE, - number=6, - message='InsightStateInfo', - ) - category = proto.Field( - proto.ENUM, - number=7, - enum=Category, - ) - etag = proto.Field( - proto.STRING, - number=11, - ) - associated_recommendations = proto.RepeatedField( - proto.MESSAGE, - number=8, - message=RecommendationReference, - ) - - -class InsightStateInfo(proto.Message): - r"""Information related to insight state. - Attributes: - state (google.cloud.recommender_v1.types.InsightStateInfo.State): - Insight state. - state_metadata (Sequence[google.cloud.recommender_v1.types.InsightStateInfo.StateMetadataEntry]): - A map of metadata for the state, provided by - user or automations systems. - """ - class State(proto.Enum): - r"""Represents insight state.""" - STATE_UNSPECIFIED = 0 - ACTIVE = 1 - ACCEPTED = 2 - DISMISSED = 3 - - state = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py deleted file mode 100644 index d4a1a9a..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommendation.py +++ /dev/null @@ -1,420 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1', - manifest={ - 'Recommendation', - 'RecommendationContent', - 'OperationGroup', - 'Operation', - 'ValueMatcher', - 'CostProjection', - 'Impact', - 'RecommendationStateInfo', - }, -) - - -class Recommendation(proto.Message): - r"""A recommendation along with a suggested action. E.g., a - rightsizing recommendation for an underutilized VM, IAM role - recommendations, etc - - Attributes: - name (str): - Name of recommendation. - description (str): - Free-form human readable summary in English. - The maximum length is 500 characters. - recommender_subtype (str): - Contains an identifier for a subtype of recommendations - produced for the same recommender. Subtype is a function of - content and impact, meaning a new subtype might be added - when significant changes to ``content`` or - ``primary_impact.category`` are introduced. See the - Recommenders section to see a list of subtypes for a given - Recommender. - - Examples: For recommender = "google.iam.policy.Recommender", - recommender_subtype can be one of - "REMOVE_ROLE"/"REPLACE_ROLE". - last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): - Last time this recommendation was refreshed - by the system that created it in the first - place. - primary_impact (google.cloud.recommender_v1.types.Impact): - The primary impact that this recommendation - can have while trying to optimize for one - category. - additional_impact (Sequence[google.cloud.recommender_v1.types.Impact]): - Optional set of additional impact that this - recommendation may have when trying to optimize - for the primary category. These may be positive - or negative. - content (google.cloud.recommender_v1.types.RecommendationContent): - Content of the recommendation describing - recommended changes to resources. - state_info (google.cloud.recommender_v1.types.RecommendationStateInfo): - Information for state. Contains state and - metadata. - etag (str): - Fingerprint of the Recommendation. Provides - optimistic locking when updating states. - associated_insights (Sequence[google.cloud.recommender_v1.types.Recommendation.InsightReference]): - Insights that led to this recommendation. - """ - - class InsightReference(proto.Message): - r"""Reference to an associated insight. - Attributes: - insight (str): - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - """ - - insight = proto.Field( - proto.STRING, - number=1, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - description = proto.Field( - proto.STRING, - number=2, - ) - recommender_subtype = proto.Field( - proto.STRING, - number=12, - ) - last_refresh_time = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - primary_impact = proto.Field( - proto.MESSAGE, - number=5, - message='Impact', - ) - additional_impact = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='Impact', - ) - content = proto.Field( - proto.MESSAGE, - number=7, - message='RecommendationContent', - ) - state_info = proto.Field( - proto.MESSAGE, - number=10, - message='RecommendationStateInfo', - ) - etag = proto.Field( - proto.STRING, - number=11, - ) - associated_insights = proto.RepeatedField( - proto.MESSAGE, - number=14, - message=InsightReference, - ) - - -class RecommendationContent(proto.Message): - r"""Contains what resources are changing and how they are - changing. - - Attributes: - operation_groups (Sequence[google.cloud.recommender_v1.types.OperationGroup]): - Operations to one or more Google Cloud - resources grouped in such a way that, all - operations within one group are expected to be - performed atomically and in an order. - """ - - operation_groups = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='OperationGroup', - ) - - -class OperationGroup(proto.Message): - r"""Group of operations that need to be performed atomically. - Attributes: - operations (Sequence[google.cloud.recommender_v1.types.Operation]): - List of operations across one or more - resources that belong to this group. Loosely - based on RFC6902 and should be performed in the - order they appear. - """ - - operations = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Operation', - ) - - -class Operation(proto.Message): - r"""Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: - - - Custom filters for describing partial array patch. - - Extended path values for describing nested arrays. - - Custom fields for describing the resource for which the operation - is being described. - - Allows extension to custom operations not natively supported by - RFC6902. See https://tools.ietf.org/html/rfc6902 for details on - the original RFC. - - Attributes: - action (str): - Type of this operation. Contains one of - 'and', 'remove', 'replace', 'move', 'copy', - 'test' and custom operations. This field is - case-insensitive and always populated. - resource_type (str): - Type of GCP resource being modified/tested. - This field is always populated. Example: - cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - resource (str): - Contains the fully qualified resource name. - This field is always populated. ex: - //cloudresourcemanager.googleapis.com/projects/foo. - path (str): - Path to the target field being operated on. - If the operation is at the resource level, then - path should be "/". This field is always - populated. - source_resource (str): - Can be set with action 'copy' to copy resource configuration - across different resources of the same type. Example: A - resource clone can be done via action = 'copy', path = "/", - from = "/", source_resource = and resource_name = . This - field is empty for all other values of ``action``. - source_path (str): - Can be set with action 'copy' or 'move' to indicate the - source field within resource or source_resource, ignored if - provided for other operation types. - value (google.protobuf.struct_pb2.Value): - Value for the ``path`` field. Will be set for - actions:'add'/'replace'. Maybe set for action: 'test'. - Either this or ``value_matcher`` will be set for 'test' - operation. An exact match must be performed. - value_matcher (google.cloud.recommender_v1.types.ValueMatcher): - Can be set for action 'test' for advanced matching for the - value of 'path' field. Either this or ``value`` will be set - for 'test' operation. - path_filters (Sequence[google.cloud.recommender_v1.types.Operation.PathFiltersEntry]): - Set of filters to apply if ``path`` refers to array elements - or nested array elements in order to narrow down to a single - unique element that is being tested/modified. This is - intended to be an exact match per filter. To perform - advanced matching, use path_value_matchers. - - - Example: { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } - - Example: { "/bindings/*/role": "roles/owner" - "/bindings/*/condition" : null } - - Example: { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", - "y@example.com"] } When both path_filters and - path_value_matchers are set, an implicit AND must be - performed. - path_value_matchers (Sequence[google.cloud.recommender_v1.types.Operation.PathValueMatchersEntry]): - Similar to path_filters, this contains set of filters to - apply if ``path`` field referes to array elements. This is - meant to support value matching beyond exact match. To - perform exact match, use path_filters. When both - path_filters and path_value_matchers are set, an implicit - AND must be performed. - """ - - action = proto.Field( - proto.STRING, - number=1, - ) - resource_type = proto.Field( - proto.STRING, - number=2, - ) - resource = proto.Field( - proto.STRING, - number=3, - ) - path = proto.Field( - proto.STRING, - number=4, - ) - source_resource = proto.Field( - proto.STRING, - number=5, - ) - source_path = proto.Field( - proto.STRING, - number=6, - ) - value = proto.Field( - proto.MESSAGE, - number=7, - oneof='path_value', - message=struct_pb2.Value, - ) - value_matcher = proto.Field( - proto.MESSAGE, - number=10, - oneof='path_value', - message='ValueMatcher', - ) - path_filters = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=8, - message=struct_pb2.Value, - ) - path_value_matchers = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=11, - message='ValueMatcher', - ) - - -class ValueMatcher(proto.Message): - r"""Contains various matching options for values for a GCP - resource field. - - Attributes: - matches_pattern (str): - To be used for full regex matching. The - regular expression is using the Google RE2 - syntax - (https://github.com/google/re2/wiki/Syntax), so - to be used with RE2::FullMatch - """ - - matches_pattern = proto.Field( - proto.STRING, - number=1, - oneof='match_variant', - ) - - -class CostProjection(proto.Message): - r"""Contains metadata about how much money a recommendation can - save or incur. - - Attributes: - cost (google.type.money_pb2.Money): - An approximate projection on amount saved or - amount incurred. Negative cost units indicate - cost savings and positive cost units indicate - increase. See google.type.Money documentation - for positive/negative units. - duration (google.protobuf.duration_pb2.Duration): - Duration for which this cost applies. - """ - - cost = proto.Field( - proto.MESSAGE, - number=1, - message=money_pb2.Money, - ) - duration = proto.Field( - proto.MESSAGE, - number=2, - message=duration_pb2.Duration, - ) - - -class Impact(proto.Message): - r"""Contains the impact a recommendation can have for a given - category. - - Attributes: - category (google.cloud.recommender_v1.types.Impact.Category): - Category that is being targeted. - cost_projection (google.cloud.recommender_v1.types.CostProjection): - Use with CategoryType.COST - """ - class Category(proto.Enum): - r"""The category of the impact.""" - CATEGORY_UNSPECIFIED = 0 - COST = 1 - SECURITY = 2 - PERFORMANCE = 3 - MANAGEABILITY = 4 - - category = proto.Field( - proto.ENUM, - number=1, - enum=Category, - ) - cost_projection = proto.Field( - proto.MESSAGE, - number=100, - oneof='projection', - message='CostProjection', - ) - - -class RecommendationStateInfo(proto.Message): - r"""Information for state. Contains state and metadata. - Attributes: - state (google.cloud.recommender_v1.types.RecommendationStateInfo.State): - The state of the recommendation, Eg ACTIVE, - SUCCEEDED, FAILED. - state_metadata (Sequence[google.cloud.recommender_v1.types.RecommendationStateInfo.StateMetadataEntry]): - A map of metadata for the state, provided by - user or automations systems. - """ - class State(proto.Enum): - r"""Represents Recommendation State.""" - STATE_UNSPECIFIED = 0 - ACTIVE = 1 - CLAIMED = 6 - SUCCEEDED = 3 - FAILED = 4 - DISMISSED = 5 - - state = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py b/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py deleted file mode 100644 index 09bff83..0000000 --- a/owl-bot-staging/v1/google/cloud/recommender_v1/types/recommender_service.py +++ /dev/null @@ -1,335 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1', - manifest={ - 'ListInsightsRequest', - 'ListInsightsResponse', - 'GetInsightRequest', - 'MarkInsightAcceptedRequest', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'GetRecommendationRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationSucceededRequest', - 'MarkRecommendationFailedRequest', - }, -) - - -class ListInsightsRequest(proto.Message): - r"""Request for the ``ListInsights`` method. - Attributes: - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID - refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types.) - page_size (int): - Optional. The maximum number of results to - return from this request. Non-positive values - are ignored. If not specified, the server will - determine the number of results to return. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters must be - identical to those in the previous call. - filter (str): - Optional. Filter expression to restrict the insights - returned. Supported filter fields: state Eg: - \`state:"DISMISSED" or state:"ACTIVE". - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - - -class ListInsightsResponse(proto.Message): - r"""Response to the ``ListInsights`` method. - Attributes: - insights (Sequence[google.cloud.recommender_v1.types.Insight]): - The set of insights for the ``parent`` resource. - next_page_token (str): - A token that can be used to request the next - page of results. This field is empty if there - are no additional results. - """ - - @property - def raw_page(self): - return self - - insights = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=insight.Insight, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetInsightRequest(proto.Message): - r"""Request to the ``GetInsight`` method. - Attributes: - name (str): - Required. Name of the insight. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class MarkInsightAcceptedRequest(proto.Message): - r"""Request for the ``MarkInsightAccepted`` method. - Attributes: - name (str): - Required. Name of the insight. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): - Optional. State properties user wish to include with this - state. Full replace of the current state_metadata. - etag (str): - Required. Fingerprint of the Insight. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class ListRecommendationsRequest(proto.Message): - r"""Request for the ``ListRecommendations`` method. - Attributes: - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - page_size (int): - Optional. The maximum number of results to - return from this request. Non-positive values - are ignored. If not specified, the server will - determine the number of results to return. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters must be - identical to those in the previous call. - filter (str): - Filter expression to restrict the recommendations returned. - Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or state_info.state:"FAILED". - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=5, - ) - - -class ListRecommendationsResponse(proto.Message): - r"""Response to the ``ListRecommendations`` method. - Attributes: - recommendations (Sequence[google.cloud.recommender_v1.types.Recommendation]): - The set of recommendations for the ``parent`` resource. - next_page_token (str): - A token that can be used to request the next - page of results. This field is empty if there - are no additional results. - """ - - @property - def raw_page(self): - return self - - recommendations = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=recommendation.Recommendation, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetRecommendationRequest(proto.Message): - r"""Request to the ``GetRecommendation`` method. - Attributes: - name (str): - Required. Name of the recommendation. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class MarkRecommendationClaimedRequest(proto.Message): - r"""Request for the ``MarkRecommendationClaimed`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class MarkRecommendationSucceededRequest(proto.Message): - r"""Request for the ``MarkRecommendationSucceeded`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class MarkRecommendationFailedRequest(proto.Message): - r"""Request for the ``MarkRecommendationFailed`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 7f2d2b5..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/recommender_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', 'types-pkg_resources') - 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_recommender_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py deleted file mode 100644 index c0fe445..0000000 --- a/owl-bot-staging/v1/scripts/fixup_recommender_v1_keywords.py +++ /dev/null @@ -1,183 +0,0 @@ -#! /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 recommenderCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'get_insight': ('name', ), - 'get_recommendation': ('name', ), - 'list_insights': ('parent', 'page_size', 'page_token', 'filter', ), - 'list_recommendations': ('parent', 'page_size', 'page_token', 'filter', ), - 'mark_insight_accepted': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_claimed': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_failed': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_succeeded': ('name', 'etag', 'state_metadata', ), - } - - 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=recommenderCallTransformer(), -): - """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 recommender client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index fc7260d..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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-recommender', - 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.27.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - 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', - 'Programming Language :: Python :: 3.9', - '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 deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/recommender_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/recommender_v1/test_recommender.py b/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py deleted file mode 100644 index 019c8f1..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recommender_v1/test_recommender.py +++ /dev/null @@ -1,3377 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.recommender_v1.services.recommender import RecommenderAsyncClient -from google.cloud.recommender_v1.services.recommender import RecommenderClient -from google.cloud.recommender_v1.services.recommender import pagers -from google.cloud.recommender_v1.services.recommender import transports -from google.cloud.recommender_v1.services.recommender.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.recommender_v1.types import insight -from google.cloud.recommender_v1.types import recommendation -from google.cloud.recommender_v1.types import recommender_service -from google.oauth2 import service_account -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the 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", -) - -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 RecommenderClient._get_default_mtls_endpoint(None) is None - assert RecommenderClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - RecommenderClient, - RecommenderAsyncClient, -]) -def test_recommender_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'recommender.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.RecommenderGrpcTransport, "grpc"), - (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - RecommenderClient, - RecommenderAsyncClient, -]) -def test_recommender_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - 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 == 'recommender.googleapis.com:443' - - -def test_recommender_client_get_transport_class(): - transport = RecommenderClient.get_transport_class() - available_transports = [ - transports.RecommenderGrpcTransport, - ] - assert transport in available_transports - - transport = RecommenderClient.get_transport_class("grpc") - assert transport == transports.RecommenderGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) -@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) -def test_recommender_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(RecommenderClient, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(RecommenderClient, '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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "true"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "false"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) -@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_recommender_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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_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, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_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, - always_use_jwt_access=True, - ) - - -def test_recommender_client_client_options_from_dict(): - with mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = RecommenderClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_list_insights(transport: str = 'grpc', request_type=recommender_service.ListInsightsRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_insights(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListInsightsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_insights_from_dict(): - test_list_insights(request_type=dict) - - -def test_list_insights_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - client.list_insights() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - -@pytest.mark.asyncio -async def test_list_insights_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListInsightsRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_insights(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListInsightsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_insights_async_from_dict(): - await test_list_insights_async(request_type=dict) - - -def test_list_insights_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListInsightsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - call.return_value = recommender_service.ListInsightsResponse() - client.list_insights(request) - - # Establish that the 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_insights_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListInsightsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) - await client.list_insights(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_insights_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_insights( - 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_insights_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_insights( - recommender_service.ListInsightsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_insights_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_insights( - 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_insights_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_insights( - recommender_service.ListInsightsRequest(), - parent='parent_value', - ) - - -def test_list_insights_pager(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_insights(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, insight.Insight) - for i in results) - -def test_list_insights_pages(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - pages = list(client.list_insights(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_insights_async_pager(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_insights(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, insight.Insight) - for i in responses) - -@pytest.mark.asyncio -async def test_list_insights_async_pages(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_insights(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_insight(transport: str = 'grpc', request_type=recommender_service.GetInsightRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - ) - response = client.get_insight(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -def test_get_insight_from_dict(): - test_get_insight(request_type=dict) - - -def test_get_insight_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - client.get_insight() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - -@pytest.mark.asyncio -async def test_get_insight_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetInsightRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - )) - response = await client.get_insight(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_insight_async_from_dict(): - await test_get_insight_async(request_type=dict) - - -def test_get_insight_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetInsightRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - call.return_value = insight.Insight() - client.get_insight(request) - - # Establish that the 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_insight_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetInsightRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - await client.get_insight(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_insight_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_insight( - 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_insight_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_insight( - recommender_service.GetInsightRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_insight_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_insight( - 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_insight_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_insight( - recommender_service.GetInsightRequest(), - name='name_value', - ) - - -def test_mark_insight_accepted(transport: str = 'grpc', request_type=recommender_service.MarkInsightAcceptedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - ) - response = client.mark_insight_accepted(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -def test_mark_insight_accepted_from_dict(): - test_mark_insight_accepted(request_type=dict) - - -def test_mark_insight_accepted_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - client.mark_insight_accepted() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkInsightAcceptedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - )) - response = await client.mark_insight_accepted(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_async_from_dict(): - await test_mark_insight_accepted_async(request_type=dict) - - -def test_mark_insight_accepted_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkInsightAcceptedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - call.return_value = insight.Insight() - client.mark_insight_accepted(request) - - # Establish that the 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_mark_insight_accepted_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkInsightAcceptedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - await client.mark_insight_accepted(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_mark_insight_accepted_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_insight_accepted( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_insight_accepted_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_insight_accepted( - recommender_service.MarkInsightAcceptedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_insight_accepted( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_insight_accepted( - recommender_service.MarkInsightAcceptedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_list_recommendations(transport: str = 'grpc', request_type=recommender_service.ListRecommendationsRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_recommendations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRecommendationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_recommendations_from_dict(): - test_list_recommendations(request_type=dict) - - -def test_list_recommendations_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - client.list_recommendations() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - -@pytest.mark.asyncio -async def test_list_recommendations_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListRecommendationsRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_recommendations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRecommendationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_recommendations_async_from_dict(): - await test_list_recommendations_async(request_type=dict) - - -def test_list_recommendations_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListRecommendationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - call.return_value = recommender_service.ListRecommendationsResponse() - client.list_recommendations(request) - - # Establish that the 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_recommendations_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListRecommendationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) - await client.list_recommendations(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_recommendations_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_recommendations( - parent='parent_value', - filter='filter_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' - assert args[0].filter == 'filter_value' - - -def test_list_recommendations_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_recommendations( - recommender_service.ListRecommendationsRequest(), - parent='parent_value', - filter='filter_value', - ) - - -@pytest.mark.asyncio -async def test_list_recommendations_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_recommendations( - parent='parent_value', - filter='filter_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' - assert args[0].filter == 'filter_value' - - -@pytest.mark.asyncio -async def test_list_recommendations_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_recommendations( - recommender_service.ListRecommendationsRequest(), - parent='parent_value', - filter='filter_value', - ) - - -def test_list_recommendations_pager(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_recommendations(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, recommendation.Recommendation) - for i in results) - -def test_list_recommendations_pages(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - pages = list(client.list_recommendations(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_recommendations_async_pager(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_recommendations(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, recommendation.Recommendation) - for i in responses) - -@pytest.mark.asyncio -async def test_list_recommendations_async_pages(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_recommendations(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_recommendation(transport: str = 'grpc', request_type=recommender_service.GetRecommendationRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.get_recommendation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_get_recommendation_from_dict(): - test_get_recommendation(request_type=dict) - - -def test_get_recommendation_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - client.get_recommendation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - -@pytest.mark.asyncio -async def test_get_recommendation_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetRecommendationRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.get_recommendation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_recommendation_async_from_dict(): - await test_get_recommendation_async(request_type=dict) - - -def test_get_recommendation_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetRecommendationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.get_recommendation(request) - - # Establish that the 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_recommendation_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetRecommendationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.get_recommendation(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_recommendation_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_recommendation( - 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_recommendation_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_recommendation( - recommender_service.GetRecommendationRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_recommendation_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_recommendation( - 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_recommendation_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_recommendation( - recommender_service.GetRecommendationRequest(), - name='name_value', - ) - - -def test_mark_recommendation_claimed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationClaimedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_claimed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_claimed_from_dict(): - test_mark_recommendation_claimed(request_type=dict) - - -def test_mark_recommendation_claimed_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - client.mark_recommendation_claimed() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationClaimedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_claimed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_async_from_dict(): - await test_mark_recommendation_claimed_async(request_type=dict) - - -def test_mark_recommendation_claimed_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationClaimedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_claimed(request) - - # Establish that the 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_mark_recommendation_claimed_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationClaimedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_claimed(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_mark_recommendation_claimed_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_claimed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_claimed_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_claimed( - recommender_service.MarkRecommendationClaimedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_claimed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_claimed( - recommender_service.MarkRecommendationClaimedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_mark_recommendation_succeeded(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationSucceededRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_succeeded(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_succeeded_from_dict(): - test_mark_recommendation_succeeded(request_type=dict) - - -def test_mark_recommendation_succeeded_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - client.mark_recommendation_succeeded() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationSucceededRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_succeeded(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_async_from_dict(): - await test_mark_recommendation_succeeded_async(request_type=dict) - - -def test_mark_recommendation_succeeded_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationSucceededRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_succeeded(request) - - # Establish that the 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_mark_recommendation_succeeded_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationSucceededRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_succeeded(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_mark_recommendation_succeeded_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_succeeded( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_succeeded_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_succeeded( - recommender_service.MarkRecommendationSucceededRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_succeeded( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_succeeded( - recommender_service.MarkRecommendationSucceededRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_mark_recommendation_failed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationFailedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_failed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_failed_from_dict(): - test_mark_recommendation_failed(request_type=dict) - - -def test_mark_recommendation_failed_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - client.mark_recommendation_failed() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationFailedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_failed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_async_from_dict(): - await test_mark_recommendation_failed_async(request_type=dict) - - -def test_mark_recommendation_failed_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationFailedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_failed(request) - - # Establish that the 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_mark_recommendation_failed_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationFailedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_failed(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_mark_recommendation_failed_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_failed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_failed_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_failed( - recommender_service.MarkRecommendationFailedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_failed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_failed( - recommender_service.MarkRecommendationFailedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = RecommenderClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.RecommenderGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.RecommenderGrpcTransport, - ) - -def test_recommender_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_recommender_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'list_insights', - 'get_insight', - 'mark_insight_accepted', - 'list_recommendations', - 'get_recommendation', - 'mark_recommendation_claimed', - 'mark_recommendation_succeeded', - 'mark_recommendation_failed', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_recommender_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport( - 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_recommender_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport( - 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_recommender_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_recommender_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecommenderClient() - 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_recommender_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecommenderClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_recommender_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_recommender_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(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_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.RecommenderGrpcTransport, grpc_helpers), - (transports.RecommenderGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_recommender_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "recommender.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="recommender.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_recommender_host_no_port(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com'), - ) - assert client.transport._host == 'recommender.googleapis.com:443' - - -def test_recommender_host_with_port(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com:8000'), - ) - assert client.transport._host == 'recommender.googleapis.com:8000' - -def test_recommender_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecommenderGrpcTransport( - 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_recommender_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecommenderGrpcAsyncIOTransport( - 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.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_insight_path(): - project = "squid" - location = "clam" - insight_type = "whelk" - insight = "octopus" - expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) - actual = RecommenderClient.insight_path(project, location, insight_type, insight) - assert expected == actual - - -def test_parse_insight_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - "insight_type": "cuttlefish", - "insight": "mussel", - } - path = RecommenderClient.insight_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_insight_path(path) - assert expected == actual - -def test_insight_type_path(): - project = "winkle" - location = "nautilus" - insight_type = "scallop" - expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) - actual = RecommenderClient.insight_type_path(project, location, insight_type) - assert expected == actual - - -def test_parse_insight_type_path(): - expected = { - "project": "abalone", - "location": "squid", - "insight_type": "clam", - } - path = RecommenderClient.insight_type_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_insight_type_path(path) - assert expected == actual - -def test_recommendation_path(): - project = "whelk" - location = "octopus" - recommender = "oyster" - recommendation = "nudibranch" - expected = "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) - actual = RecommenderClient.recommendation_path(project, location, recommender, recommendation) - assert expected == actual - - -def test_parse_recommendation_path(): - expected = { - "project": "cuttlefish", - "location": "mussel", - "recommender": "winkle", - "recommendation": "nautilus", - } - path = RecommenderClient.recommendation_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_recommendation_path(path) - assert expected == actual - -def test_recommender_path(): - project = "scallop" - location = "abalone" - recommender = "squid" - expected = "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) - actual = RecommenderClient.recommender_path(project, location, recommender) - assert expected == actual - - -def test_parse_recommender_path(): - expected = { - "project": "clam", - "location": "whelk", - "recommender": "octopus", - } - path = RecommenderClient.recommender_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_recommender_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "oyster" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = RecommenderClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "nudibranch", - } - path = RecommenderClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "cuttlefish" - expected = "folders/{folder}".format(folder=folder, ) - actual = RecommenderClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "mussel", - } - path = RecommenderClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "winkle" - expected = "organizations/{organization}".format(organization=organization, ) - actual = RecommenderClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nautilus", - } - path = RecommenderClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "scallop" - expected = "projects/{project}".format(project=project, ) - actual = RecommenderClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "abalone", - } - path = RecommenderClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "squid" - location = "clam" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = RecommenderClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "whelk", - "location": "octopus", - } - path = RecommenderClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.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.RecommenderTransport, '_prep_wrapped_messages') as prep: - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.RecommenderTransport, '_prep_wrapped_messages') as prep: - transport_class = RecommenderClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1beta1/.coveragerc b/owl-bot-staging/v1beta1/.coveragerc deleted file mode 100644 index cacc3bc..0000000 --- a/owl-bot-staging/v1beta1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/recommender/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1beta1/MANIFEST.in b/owl-bot-staging/v1beta1/MANIFEST.in deleted file mode 100644 index 6eb35c3..0000000 --- a/owl-bot-staging/v1beta1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/recommender *.py -recursive-include google/cloud/recommender_v1beta1 *.py diff --git a/owl-bot-staging/v1beta1/README.rst b/owl-bot-staging/v1beta1/README.rst deleted file mode 100644 index 3728662..0000000 --- a/owl-bot-staging/v1beta1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Recommender 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 Recommender API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1beta1/docs/conf.py b/owl-bot-staging/v1beta1/docs/conf.py deleted file mode 100644 index 49094fc..0000000 --- a/owl-bot-staging/v1beta1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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-recommender 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-recommender" -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-recommender-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-recommender.tex", - u"google-cloud-recommender 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-recommender", - u"Google Cloud Recommender 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-recommender", - u"google-cloud-recommender Documentation", - author, - "google-cloud-recommender", - "GAPIC library for Google Cloud Recommender API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1beta1/docs/index.rst b/owl-bot-staging/v1beta1/docs/index.rst deleted file mode 100644 index ae8ca96..0000000 --- a/owl-bot-staging/v1beta1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - recommender_v1beta1/services - recommender_v1beta1/types diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst deleted file mode 100644 index 5e69281..0000000 --- a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/recommender.rst +++ /dev/null @@ -1,10 +0,0 @@ -Recommender ------------------------------ - -.. automodule:: google.cloud.recommender_v1beta1.services.recommender - :members: - :inherited-members: - -.. automodule:: google.cloud.recommender_v1beta1.services.recommender.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst deleted file mode 100644 index 5341142..0000000 --- a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Recommender v1beta1 API -================================================= -.. toctree:: - :maxdepth: 2 - - recommender diff --git a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst b/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst deleted file mode 100644 index 16ab2a8..0000000 --- a/owl-bot-staging/v1beta1/docs/recommender_v1beta1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Recommender v1beta1 API -============================================== - -.. automodule:: google.cloud.recommender_v1beta1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py deleted file mode 100644 index eacd933..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender/__init__.py +++ /dev/null @@ -1,63 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender_v1beta1.services.recommender.client import RecommenderClient -from google.cloud.recommender_v1beta1.services.recommender.async_client import RecommenderAsyncClient - -from google.cloud.recommender_v1beta1.types.insight import Insight -from google.cloud.recommender_v1beta1.types.insight import InsightStateInfo -from google.cloud.recommender_v1beta1.types.recommendation import CostProjection -from google.cloud.recommender_v1beta1.types.recommendation import Impact -from google.cloud.recommender_v1beta1.types.recommendation import Operation -from google.cloud.recommender_v1beta1.types.recommendation import OperationGroup -from google.cloud.recommender_v1beta1.types.recommendation import Recommendation -from google.cloud.recommender_v1beta1.types.recommendation import RecommendationContent -from google.cloud.recommender_v1beta1.types.recommendation import RecommendationStateInfo -from google.cloud.recommender_v1beta1.types.recommendation import ValueMatcher -from google.cloud.recommender_v1beta1.types.recommender_service import GetInsightRequest -from google.cloud.recommender_v1beta1.types.recommender_service import GetRecommendationRequest -from google.cloud.recommender_v1beta1.types.recommender_service import ListInsightsRequest -from google.cloud.recommender_v1beta1.types.recommender_service import ListInsightsResponse -from google.cloud.recommender_v1beta1.types.recommender_service import ListRecommendationsRequest -from google.cloud.recommender_v1beta1.types.recommender_service import ListRecommendationsResponse -from google.cloud.recommender_v1beta1.types.recommender_service import MarkInsightAcceptedRequest -from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationClaimedRequest -from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationFailedRequest -from google.cloud.recommender_v1beta1.types.recommender_service import MarkRecommendationSucceededRequest - -__all__ = ('RecommenderClient', - 'RecommenderAsyncClient', - 'Insight', - 'InsightStateInfo', - 'CostProjection', - 'Impact', - 'Operation', - 'OperationGroup', - 'Recommendation', - 'RecommendationContent', - 'RecommendationStateInfo', - 'ValueMatcher', - 'GetInsightRequest', - 'GetRecommendationRequest', - 'ListInsightsRequest', - 'ListInsightsResponse', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'MarkInsightAcceptedRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationFailedRequest', - 'MarkRecommendationSucceededRequest', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed b/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed deleted file mode 100644 index f9105be..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py deleted file mode 100644 index 8bc995e..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/__init__.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender import RecommenderClient -from .services.recommender import RecommenderAsyncClient - -from .types.insight import Insight -from .types.insight import InsightStateInfo -from .types.recommendation import CostProjection -from .types.recommendation import Impact -from .types.recommendation import Operation -from .types.recommendation import OperationGroup -from .types.recommendation import Recommendation -from .types.recommendation import RecommendationContent -from .types.recommendation import RecommendationStateInfo -from .types.recommendation import ValueMatcher -from .types.recommender_service import GetInsightRequest -from .types.recommender_service import GetRecommendationRequest -from .types.recommender_service import ListInsightsRequest -from .types.recommender_service import ListInsightsResponse -from .types.recommender_service import ListRecommendationsRequest -from .types.recommender_service import ListRecommendationsResponse -from .types.recommender_service import MarkInsightAcceptedRequest -from .types.recommender_service import MarkRecommendationClaimedRequest -from .types.recommender_service import MarkRecommendationFailedRequest -from .types.recommender_service import MarkRecommendationSucceededRequest - -__all__ = ( - 'RecommenderAsyncClient', -'CostProjection', -'GetInsightRequest', -'GetRecommendationRequest', -'Impact', -'Insight', -'InsightStateInfo', -'ListInsightsRequest', -'ListInsightsResponse', -'ListRecommendationsRequest', -'ListRecommendationsResponse', -'MarkInsightAcceptedRequest', -'MarkRecommendationClaimedRequest', -'MarkRecommendationFailedRequest', -'MarkRecommendationSucceededRequest', -'Operation', -'OperationGroup', -'Recommendation', -'RecommendationContent', -'RecommendationStateInfo', -'RecommenderClient', -'ValueMatcher', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json deleted file mode 100644 index 02139b9..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/gapic_metadata.json +++ /dev/null @@ -1,103 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.recommender_v1beta1", - "protoPackage": "google.cloud.recommender.v1beta1", - "schema": "1.0", - "services": { - "Recommender": { - "clients": { - "grpc": { - "libraryClient": "RecommenderClient", - "rpcs": { - "GetInsight": { - "methods": [ - "get_insight" - ] - }, - "GetRecommendation": { - "methods": [ - "get_recommendation" - ] - }, - "ListInsights": { - "methods": [ - "list_insights" - ] - }, - "ListRecommendations": { - "methods": [ - "list_recommendations" - ] - }, - "MarkInsightAccepted": { - "methods": [ - "mark_insight_accepted" - ] - }, - "MarkRecommendationClaimed": { - "methods": [ - "mark_recommendation_claimed" - ] - }, - "MarkRecommendationFailed": { - "methods": [ - "mark_recommendation_failed" - ] - }, - "MarkRecommendationSucceeded": { - "methods": [ - "mark_recommendation_succeeded" - ] - } - } - }, - "grpc-async": { - "libraryClient": "RecommenderAsyncClient", - "rpcs": { - "GetInsight": { - "methods": [ - "get_insight" - ] - }, - "GetRecommendation": { - "methods": [ - "get_recommendation" - ] - }, - "ListInsights": { - "methods": [ - "list_insights" - ] - }, - "ListRecommendations": { - "methods": [ - "list_recommendations" - ] - }, - "MarkInsightAccepted": { - "methods": [ - "mark_insight_accepted" - ] - }, - "MarkRecommendationClaimed": { - "methods": [ - "mark_recommendation_claimed" - ] - }, - "MarkRecommendationFailed": { - "methods": [ - "mark_recommendation_failed" - ] - }, - "MarkRecommendationSucceeded": { - "methods": [ - "mark_recommendation_succeeded" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed deleted file mode 100644 index f9105be..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recommender package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py deleted file mode 100644 index 09e2c3c..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 RecommenderClient -from .async_client import RecommenderAsyncClient - -__all__ = ( - 'RecommenderClient', - 'RecommenderAsyncClient', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py deleted file mode 100644 index 4933323..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/async_client.py +++ /dev/null @@ -1,993 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1beta1.services.recommender import pagers -from google.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport -from .client import RecommenderClient - - -class RecommenderAsyncClient: - """Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - """ - - _client: RecommenderClient - - DEFAULT_ENDPOINT = RecommenderClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = RecommenderClient.DEFAULT_MTLS_ENDPOINT - - insight_path = staticmethod(RecommenderClient.insight_path) - parse_insight_path = staticmethod(RecommenderClient.parse_insight_path) - insight_type_path = staticmethod(RecommenderClient.insight_type_path) - parse_insight_type_path = staticmethod(RecommenderClient.parse_insight_type_path) - recommendation_path = staticmethod(RecommenderClient.recommendation_path) - parse_recommendation_path = staticmethod(RecommenderClient.parse_recommendation_path) - recommender_path = staticmethod(RecommenderClient.recommender_path) - parse_recommender_path = staticmethod(RecommenderClient.parse_recommender_path) - common_billing_account_path = staticmethod(RecommenderClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(RecommenderClient.parse_common_billing_account_path) - common_folder_path = staticmethod(RecommenderClient.common_folder_path) - parse_common_folder_path = staticmethod(RecommenderClient.parse_common_folder_path) - common_organization_path = staticmethod(RecommenderClient.common_organization_path) - parse_common_organization_path = staticmethod(RecommenderClient.parse_common_organization_path) - common_project_path = staticmethod(RecommenderClient.common_project_path) - parse_common_project_path = staticmethod(RecommenderClient.parse_common_project_path) - common_location_path = staticmethod(RecommenderClient.common_location_path) - parse_common_location_path = staticmethod(RecommenderClient.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: - RecommenderAsyncClient: The constructed client. - """ - return RecommenderClient.from_service_account_info.__func__(RecommenderAsyncClient, 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: - RecommenderAsyncClient: The constructed client. - """ - return RecommenderClient.from_service_account_file.__func__(RecommenderAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> RecommenderTransport: - """Returns the transport used by the client instance. - - Returns: - RecommenderTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(RecommenderClient).get_transport_class, type(RecommenderClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, RecommenderTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recommender 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, ~.RecommenderTransport]): 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 = RecommenderClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def list_insights(self, - request: recommender_service.ListInsightsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListInsightsAsyncPager: - r"""Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.ListInsightsRequest`): - The request object. Request for the `ListInsights` - method. - parent (:class:`str`): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ - INSIGHT_TYPE_ID refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types. - - 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.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager: - Response to the ListInsights method. - - 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 = recommender_service.ListInsightsRequest(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_insights, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("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.ListInsightsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_insight(self, - request: recommender_service.GetInsightRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.GetInsightRequest`): - The request object. Request to the `GetInsight` method. - name (:class:`str`): - Required. Name of the insight. - 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.recommender_v1beta1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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 = recommender_service.GetInsightRequest(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_insight, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def mark_insight_accepted(self, - request: recommender_service.MarkInsightAcceptedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest`): - The request object. Request for the - `MarkInsightAccepted` method. - name (:class:`str`): - Required. Name of the insight. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]`): - Optional. State properties user wish to include with - this state. Full replace of the current state_metadata. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the Insight. - Provides optimistic locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkInsightAcceptedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_insight_accepted, - 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_recommendations(self, - request: recommender_service.ListRecommendationsRequest = None, - *, - parent: str = None, - filter: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRecommendationsAsyncPager: - r"""Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.ListRecommendationsRequest`): - The request object. Request for the - `ListRecommendations` method. - parent (:class:`str`): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (:class:`str`): - Filter expression to restrict the recommendations - returned. Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or - state_info.state:"FAILED" - - This corresponds to the ``filter`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager: - Response to the ListRecommendations method. - - 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, filter]) - if request is 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 = recommender_service.ListRecommendationsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # 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_recommendations, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("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.ListRecommendationsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_recommendation(self, - request: recommender_service.GetRecommendationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.GetRecommendationRequest`): - The request object. Request to the `GetRecommendation` - method. - name (:class:`str`): - Required. Name of the recommendation. - 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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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 = recommender_service.GetRecommendationRequest(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_recommendation, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def mark_recommendation_claimed(self, - request: recommender_service.MarkRecommendationClaimedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest`): - The request object. Request for the - `MarkRecommendationClaimed` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationClaimedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_claimed, - 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 mark_recommendation_succeeded(self, - request: recommender_service.MarkRecommendationSucceededRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest`): - The request object. Request for the - `MarkRecommendationSucceeded` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationSucceededRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_succeeded, - 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 mark_recommendation_failed(self, - request: recommender_service.MarkRecommendationFailedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (:class:`google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest`): - The request object. Request for the - `MarkRecommendationFailed` Method. - name (:class:`str`): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (:class:`Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]`): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (:class:`str`): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 = recommender_service.MarkRecommendationFailedRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if etag is not None: - request.etag = etag - - if state_metadata: - request.state_metadata.update(state_metadata) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.mark_recommendation_failed, - 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 - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recommender", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecommenderAsyncClient", -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py deleted file mode 100644 index fdbcc02..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/client.py +++ /dev/null @@ -1,1179 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 as core_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 as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1beta1.services.recommender import pagers -from google.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import RecommenderGrpcTransport -from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport - - -class RecommenderClientMeta(type): - """Metaclass for the Recommender 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[RecommenderTransport]] - _transport_registry["grpc"] = RecommenderGrpcTransport - _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[RecommenderTransport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class RecommenderClient(metaclass=RecommenderClientMeta): - """Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "recommender.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: - RecommenderClient: 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: - RecommenderClient: 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) -> RecommenderTransport: - """Returns the transport used by the client instance. - - Returns: - RecommenderTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def insight_path(project: str,location: str,insight_type: str,insight: str,) -> str: - """Returns a fully-qualified insight string.""" - return "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) - - @staticmethod - def parse_insight_path(path: str) -> Dict[str,str]: - """Parses a insight path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)/insights/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def insight_type_path(project: str,location: str,insight_type: str,) -> str: - """Returns a fully-qualified insight_type string.""" - return "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) - - @staticmethod - def parse_insight_type_path(path: str) -> Dict[str,str]: - """Parses a insight_type path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/insightTypes/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def recommendation_path(project: str,location: str,recommender: str,recommendation: str,) -> str: - """Returns a fully-qualified recommendation string.""" - return "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) - - @staticmethod - def parse_recommendation_path(path: str) -> Dict[str,str]: - """Parses a recommendation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)/recommendations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def recommender_path(project: str,location: str,recommender: str,) -> str: - """Returns a fully-qualified recommender string.""" - return "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) - - @staticmethod - def parse_recommender_path(path: str) -> Dict[str,str]: - """Parses a recommender path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/recommenders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, RecommenderTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recommender 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, RecommenderTransport]): 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() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = 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": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = 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, RecommenderTransport): - # transport is a RecommenderTransport 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, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), - ) - - def list_insights(self, - request: recommender_service.ListInsightsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListInsightsPager: - r"""Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Args: - request (google.cloud.recommender_v1beta1.types.ListInsightsRequest): - The request object. Request for the `ListInsights` - method. - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ - INSIGHT_TYPE_ID refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types. - - 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.recommender_v1beta1.services.recommender.pagers.ListInsightsPager: - Response to the ListInsights method. - - 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 recommender_service.ListInsightsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.ListInsightsRequest): - request = recommender_service.ListInsightsRequest(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_insights] - - # 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.ListInsightsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_insight(self, - request: recommender_service.GetInsightRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Args: - request (google.cloud.recommender_v1beta1.types.GetInsightRequest): - The request object. Request to the `GetInsight` method. - name (str): - Required. Name of the insight. - 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.recommender_v1beta1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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 recommender_service.GetInsightRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.GetInsightRequest): - request = recommender_service.GetInsightRequest(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_insight] - - # 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 mark_insight_accepted(self, - request: recommender_service.MarkInsightAcceptedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> insight.Insight: - r"""Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Args: - request (google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest): - The request object. Request for the - `MarkInsightAccepted` method. - name (str): - Required. Name of the insight. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): - Optional. State properties user wish to include with - this state. Full replace of the current state_metadata. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the Insight. - Provides optimistic locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Insight: - An insight along with the information - used to derive the insight. The insight - may have associated recomendations as - well. - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkInsightAcceptedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkInsightAcceptedRequest): - request = recommender_service.MarkInsightAcceptedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_insight_accepted] - - # 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_recommendations(self, - request: recommender_service.ListRecommendationsRequest = None, - *, - parent: str = None, - filter: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListRecommendationsPager: - r"""Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Args: - request (google.cloud.recommender_v1beta1.types.ListRecommendationsRequest): - The request object. Request for the - `ListRecommendations` method. - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (str): - Filter expression to restrict the recommendations - returned. Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or - state_info.state:"FAILED" - - This corresponds to the ``filter`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.services.recommender.pagers.ListRecommendationsPager: - Response to the ListRecommendations method. - - 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, filter]) - if request is 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 recommender_service.ListRecommendationsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.ListRecommendationsRequest): - request = recommender_service.ListRecommendationsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_recommendations] - - # 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.ListRecommendationsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_recommendation(self, - request: recommender_service.GetRecommendationRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Args: - request (google.cloud.recommender_v1beta1.types.GetRecommendationRequest): - The request object. Request to the `GetRecommendation` - method. - name (str): - Required. Name of the recommendation. - 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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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 recommender_service.GetRecommendationRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.GetRecommendationRequest): - request = recommender_service.GetRecommendationRequest(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_recommendation] - - # 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 mark_recommendation_claimed(self, - request: recommender_service.MarkRecommendationClaimedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest): - The request object. Request for the - `MarkRecommendationClaimed` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationClaimedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationClaimedRequest): - request = recommender_service.MarkRecommendationClaimedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_claimed] - - # 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 mark_recommendation_succeeded(self, - request: recommender_service.MarkRecommendationSucceededRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest): - The request object. Request for the - `MarkRecommendationSucceeded` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationSucceededRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationSucceededRequest): - request = recommender_service.MarkRecommendationSucceededRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_succeeded] - - # 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 mark_recommendation_failed(self, - request: recommender_service.MarkRecommendationFailedRequest = None, - *, - name: str = None, - state_metadata: Sequence[recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry] = None, - etag: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recommendation.Recommendation: - r"""Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Args: - request (google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest): - The request object. Request for the - `MarkRecommendationFailed` Method. - name (str): - Required. Name of the recommendation. - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites - any existing ``state_metadata``. Keys must match the - regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match - the regex /^[a-zA-Z0-9_./-]{0,255}$/. - - This corresponds to the ``state_metadata`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - etag (str): - Required. Fingerprint of the - Recommendation. Provides optimistic - locking. - - This corresponds to the ``etag`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (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.recommender_v1beta1.types.Recommendation: - A recommendation along with a - suggested action. E.g., a rightsizing - recommendation for an underutilized VM, - IAM role recommendations, etc - - """ - # 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, state_metadata, etag]) - if request is 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 recommender_service.MarkRecommendationFailedRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recommender_service.MarkRecommendationFailedRequest): - request = recommender_service.MarkRecommendationFailedRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if state_metadata is not None: - request.state_metadata = state_metadata - if etag is not None: - request.etag = etag - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.mark_recommendation_failed] - - # 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 - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-recommender", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "RecommenderClient", -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py deleted file mode 100644 index ab7b2b4..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/pagers.py +++ /dev/null @@ -1,264 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service - - -class ListInsightsPager: - """A pager for iterating through ``list_insights`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``insights`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListInsights`` requests and continue to iterate - through the ``insights`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` - 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[..., recommender_service.ListInsightsResponse], - request: recommender_service.ListInsightsRequest, - response: recommender_service.ListInsightsResponse, - *, - 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.recommender_v1beta1.types.ListInsightsRequest): - The initial request object. - response (google.cloud.recommender_v1beta1.types.ListInsightsResponse): - 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 = recommender_service.ListInsightsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[recommender_service.ListInsightsResponse]: - 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[insight.Insight]: - for page in self.pages: - yield from page.insights - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListInsightsAsyncPager: - """A pager for iterating through ``list_insights`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``insights`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListInsights`` requests and continue to iterate - through the ``insights`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1beta1.types.ListInsightsResponse` - 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[recommender_service.ListInsightsResponse]], - request: recommender_service.ListInsightsRequest, - response: recommender_service.ListInsightsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recommender_v1beta1.types.ListInsightsRequest): - The initial request object. - response (google.cloud.recommender_v1beta1.types.ListInsightsResponse): - 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 = recommender_service.ListInsightsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[recommender_service.ListInsightsResponse]: - 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[insight.Insight]: - async def async_generator(): - async for page in self.pages: - for response in page.insights: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRecommendationsPager: - """A pager for iterating through ``list_recommendations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``recommendations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRecommendations`` requests and continue to iterate - through the ``recommendations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` - 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[..., recommender_service.ListRecommendationsResponse], - request: recommender_service.ListRecommendationsRequest, - response: recommender_service.ListRecommendationsResponse, - *, - 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.recommender_v1beta1.types.ListRecommendationsRequest): - The initial request object. - response (google.cloud.recommender_v1beta1.types.ListRecommendationsResponse): - 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 = recommender_service.ListRecommendationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[recommender_service.ListRecommendationsResponse]: - 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[recommendation.Recommendation]: - for page in self.pages: - yield from page.recommendations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRecommendationsAsyncPager: - """A pager for iterating through ``list_recommendations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``recommendations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRecommendations`` requests and continue to iterate - through the ``recommendations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recommender_v1beta1.types.ListRecommendationsResponse` - 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[recommender_service.ListRecommendationsResponse]], - request: recommender_service.ListRecommendationsRequest, - response: recommender_service.ListRecommendationsResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.recommender_v1beta1.types.ListRecommendationsRequest): - The initial request object. - response (google.cloud.recommender_v1beta1.types.ListRecommendationsResponse): - 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 = recommender_service.ListRecommendationsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[recommender_service.ListRecommendationsResponse]: - 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[recommendation.Recommendation]: - async def async_generator(): - async for page in self.pages: - for response in page.recommendations: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py deleted file mode 100644 index 18245b5..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 RecommenderTransport -from .grpc import RecommenderGrpcTransport -from .grpc_asyncio import RecommenderGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] -_transport_registry['grpc'] = RecommenderGrpcTransport -_transport_registry['grpc_asyncio'] = RecommenderGrpcAsyncIOTransport - -__all__ = ( - 'RecommenderTransport', - 'RecommenderGrpcTransport', - 'RecommenderGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py deleted file mode 100644 index 8d5283b..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/base.py +++ /dev/null @@ -1,296 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_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 as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-recommender', - ).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 = google.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 - - -class RecommenderTransport(abc.ABC): - """Abstract transport class for Recommender.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'recommender.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # 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 - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is 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 - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.list_insights: gapic_v1.method.wrap_method( - self.list_insights, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_insight: gapic_v1.method.wrap_method( - self.get_insight, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.mark_insight_accepted: gapic_v1.method.wrap_method( - self.mark_insight_accepted, - default_timeout=60.0, - client_info=client_info, - ), - self.list_recommendations: gapic_v1.method.wrap_method( - self.list_recommendations, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_recommendation: gapic_v1.method.wrap_method( - self.get_recommendation, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_claimed: gapic_v1.method.wrap_method( - self.mark_recommendation_claimed, - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_succeeded: gapic_v1.method.wrap_method( - self.mark_recommendation_succeeded, - default_timeout=60.0, - client_info=client_info, - ), - self.mark_recommendation_failed: gapic_v1.method.wrap_method( - self.mark_recommendation_failed, - default_timeout=60.0, - client_info=client_info, - ), - } - - @property - def list_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - Union[ - recommender_service.ListInsightsResponse, - Awaitable[recommender_service.ListInsightsResponse] - ]]: - raise NotImplementedError() - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - Union[ - insight.Insight, - Awaitable[insight.Insight] - ]]: - raise NotImplementedError() - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - Union[ - insight.Insight, - Awaitable[insight.Insight] - ]]: - raise NotImplementedError() - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - Union[ - recommender_service.ListRecommendationsResponse, - Awaitable[recommender_service.ListRecommendationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - Union[ - recommendation.Recommendation, - Awaitable[recommendation.Recommendation] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'RecommenderTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py deleted file mode 100644 index db4df9d..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py +++ /dev/null @@ -1,482 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service -from .base import RecommenderTransport, DEFAULT_CLIENT_INFO - - -class RecommenderGrpcTransport(RecommenderTransport): - """gRPC backend transport for Recommender. - - Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - - 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 = 'recommender.googleapis.com', - credentials: ga_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, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - 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 = 'recommender.googleapis.com', - credentials: ga_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. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def list_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - recommender_service.ListInsightsResponse]: - r"""Return a callable for the list insights method over gRPC. - - Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Returns: - Callable[[~.ListInsightsRequest], - ~.ListInsightsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insights' not in self._stubs: - self._stubs['list_insights'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/ListInsights', - request_serializer=recommender_service.ListInsightsRequest.serialize, - response_deserializer=recommender_service.ListInsightsResponse.deserialize, - ) - return self._stubs['list_insights'] - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - insight.Insight]: - r"""Return a callable for the get insight method over gRPC. - - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Returns: - Callable[[~.GetInsightRequest], - ~.Insight]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insight' not in self._stubs: - self._stubs['get_insight'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/GetInsight', - request_serializer=recommender_service.GetInsightRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['get_insight'] - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - insight.Insight]: - r"""Return a callable for the mark insight accepted method over gRPC. - - Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Returns: - Callable[[~.MarkInsightAcceptedRequest], - ~.Insight]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_insight_accepted' not in self._stubs: - self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkInsightAccepted', - request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['mark_insight_accepted'] - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - recommender_service.ListRecommendationsResponse]: - r"""Return a callable for the list recommendations method over gRPC. - - Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Returns: - Callable[[~.ListRecommendationsRequest], - ~.ListRecommendationsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendations' not in self._stubs: - self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/ListRecommendations', - request_serializer=recommender_service.ListRecommendationsRequest.serialize, - response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, - ) - return self._stubs['list_recommendations'] - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - recommendation.Recommendation]: - r"""Return a callable for the get recommendation method over gRPC. - - Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Returns: - Callable[[~.GetRecommendationRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendation' not in self._stubs: - self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/GetRecommendation', - request_serializer=recommender_service.GetRecommendationRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['get_recommendation'] - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation claimed method over gRPC. - - Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationClaimedRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_claimed' not in self._stubs: - self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationClaimed', - request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_claimed'] - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation succeeded method over gRPC. - - Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationSucceededRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_succeeded' not in self._stubs: - self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationSucceeded', - request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_succeeded'] - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - recommendation.Recommendation]: - r"""Return a callable for the mark recommendation failed method over gRPC. - - Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationFailedRequest], - ~.Recommendation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_failed' not in self._stubs: - self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationFailed', - request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_failed'] - - -__all__ = ( - 'RecommenderGrpcTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py deleted file mode 100644 index c55100e..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py +++ /dev/null @@ -1,486 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.auth import credentials as ga_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.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service -from .base import RecommenderTransport, DEFAULT_CLIENT_INFO -from .grpc import RecommenderGrpcTransport - - -class RecommenderGrpcAsyncIOTransport(RecommenderTransport): - """gRPC AsyncIO backend transport for Recommender. - - Provides insights and recommendations for cloud customers for - various categories like performance optimization, cost savings, - reliability, feature discovery, etc. Insights and - recommendations are generated automatically based on analysis of - user resources, configuration and monitoring metrics. - - 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 = 'recommender.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'recommender.googleapis.com', - credentials: ga_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, - always_use_jwt_access: Optional[bool] = False, - ) -> 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. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - 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_insights(self) -> Callable[ - [recommender_service.ListInsightsRequest], - Awaitable[recommender_service.ListInsightsResponse]]: - r"""Return a callable for the list insights method over gRPC. - - Lists insights for a Cloud project. Requires the - recommender.*.list IAM permission for the specified insight - type. - - Returns: - Callable[[~.ListInsightsRequest], - Awaitable[~.ListInsightsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insights' not in self._stubs: - self._stubs['list_insights'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/ListInsights', - request_serializer=recommender_service.ListInsightsRequest.serialize, - response_deserializer=recommender_service.ListInsightsResponse.deserialize, - ) - return self._stubs['list_insights'] - - @property - def get_insight(self) -> Callable[ - [recommender_service.GetInsightRequest], - Awaitable[insight.Insight]]: - r"""Return a callable for the get insight method over gRPC. - - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - - Returns: - Callable[[~.GetInsightRequest], - Awaitable[~.Insight]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_insight' not in self._stubs: - self._stubs['get_insight'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/GetInsight', - request_serializer=recommender_service.GetInsightRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['get_insight'] - - @property - def mark_insight_accepted(self) -> Callable[ - [recommender_service.MarkInsightAcceptedRequest], - Awaitable[insight.Insight]]: - r"""Return a callable for the mark insight accepted method over gRPC. - - Marks the Insight State as Accepted. Users can use this method - to indicate to the Recommender API that they have applied some - action based on the insight. This stops the insight content from - being updated. - - MarkInsightAccepted can be applied to insights in ACTIVE state. - Requires the recommender.*.update IAM permission for the - specified insight. - - Returns: - Callable[[~.MarkInsightAcceptedRequest], - Awaitable[~.Insight]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_insight_accepted' not in self._stubs: - self._stubs['mark_insight_accepted'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkInsightAccepted', - request_serializer=recommender_service.MarkInsightAcceptedRequest.serialize, - response_deserializer=insight.Insight.deserialize, - ) - return self._stubs['mark_insight_accepted'] - - @property - def list_recommendations(self) -> Callable[ - [recommender_service.ListRecommendationsRequest], - Awaitable[recommender_service.ListRecommendationsResponse]]: - r"""Return a callable for the list recommendations method over gRPC. - - Lists recommendations for a Cloud project. Requires the - recommender.*.list IAM permission for the specified recommender. - - Returns: - Callable[[~.ListRecommendationsRequest], - Awaitable[~.ListRecommendationsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendations' not in self._stubs: - self._stubs['list_recommendations'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/ListRecommendations', - request_serializer=recommender_service.ListRecommendationsRequest.serialize, - response_deserializer=recommender_service.ListRecommendationsResponse.deserialize, - ) - return self._stubs['list_recommendations'] - - @property - def get_recommendation(self) -> Callable[ - [recommender_service.GetRecommendationRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the get recommendation method over gRPC. - - Gets the requested recommendation. Requires the - recommender.*.get IAM permission for the specified recommender. - - Returns: - Callable[[~.GetRecommendationRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-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_recommendation' not in self._stubs: - self._stubs['get_recommendation'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/GetRecommendation', - request_serializer=recommender_service.GetRecommendationRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['get_recommendation'] - - @property - def mark_recommendation_claimed(self) -> Callable[ - [recommender_service.MarkRecommendationClaimedRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation claimed method over gRPC. - - Marks the Recommendation State as Claimed. Users can use this - method to indicate to the Recommender API that they are starting - to apply the recommendation themselves. This stops the - recommendation content from being updated. Associated insights - are frozen and placed in the ACCEPTED state. - - MarkRecommendationClaimed can be applied to recommendations in - CLAIMED or ACTIVE state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationClaimedRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_claimed' not in self._stubs: - self._stubs['mark_recommendation_claimed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationClaimed', - request_serializer=recommender_service.MarkRecommendationClaimedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_claimed'] - - @property - def mark_recommendation_succeeded(self) -> Callable[ - [recommender_service.MarkRecommendationSucceededRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation succeeded method over gRPC. - - Marks the Recommendation State as Succeeded. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation was successful. - This stops the recommendation content from being updated. - Associated insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationSucceeded can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationSucceededRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_succeeded' not in self._stubs: - self._stubs['mark_recommendation_succeeded'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationSucceeded', - request_serializer=recommender_service.MarkRecommendationSucceededRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_succeeded'] - - @property - def mark_recommendation_failed(self) -> Callable[ - [recommender_service.MarkRecommendationFailedRequest], - Awaitable[recommendation.Recommendation]]: - r"""Return a callable for the mark recommendation failed method over gRPC. - - Marks the Recommendation State as Failed. Users can use this - method to indicate to the Recommender API that they have applied - the recommendation themselves, and the operation failed. This - stops the recommendation content from being updated. Associated - insights are frozen and placed in the ACCEPTED state. - - MarkRecommendationFailed can be applied to recommendations in - ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. - - Requires the recommender.*.update IAM permission for the - specified recommender. - - Returns: - Callable[[~.MarkRecommendationFailedRequest], - Awaitable[~.Recommendation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'mark_recommendation_failed' not in self._stubs: - self._stubs['mark_recommendation_failed'] = self.grpc_channel.unary_unary( - '/google.cloud.recommender.v1beta1.Recommender/MarkRecommendationFailed', - request_serializer=recommender_service.MarkRecommendationFailedRequest.serialize, - response_deserializer=recommendation.Recommendation.deserialize, - ) - return self._stubs['mark_recommendation_failed'] - - -__all__ = ( - 'RecommenderGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py deleted file mode 100644 index 1238196..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/__init__.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 .insight import ( - Insight, - InsightStateInfo, -) -from .recommendation import ( - CostProjection, - Impact, - Operation, - OperationGroup, - Recommendation, - RecommendationContent, - RecommendationStateInfo, - ValueMatcher, -) -from .recommender_service import ( - GetInsightRequest, - GetRecommendationRequest, - ListInsightsRequest, - ListInsightsResponse, - ListRecommendationsRequest, - ListRecommendationsResponse, - MarkInsightAcceptedRequest, - MarkRecommendationClaimedRequest, - MarkRecommendationFailedRequest, - MarkRecommendationSucceededRequest, -) - -__all__ = ( - 'Insight', - 'InsightStateInfo', - 'CostProjection', - 'Impact', - 'Operation', - 'OperationGroup', - 'Recommendation', - 'RecommendationContent', - 'RecommendationStateInfo', - 'ValueMatcher', - 'GetInsightRequest', - 'GetRecommendationRequest', - 'ListInsightsRequest', - 'ListInsightsResponse', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'MarkInsightAcceptedRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationFailedRequest', - 'MarkRecommendationSucceededRequest', -) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py deleted file mode 100644 index b6a5e8e..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/insight.py +++ /dev/null @@ -1,170 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1beta1', - manifest={ - 'Insight', - 'InsightStateInfo', - }, -) - - -class Insight(proto.Message): - r"""An insight along with the information used to derive the - insight. The insight may have associated recomendations as well. - - Attributes: - name (str): - Name of the insight. - description (str): - Free-form human readable summary in English. - The maximum length is 500 characters. - target_resources (Sequence[str]): - Fully qualified resource names that this - insight is targeting. - insight_subtype (str): - Insight subtype. Insight content schema will - be stable for a given subtype. - content (google.protobuf.struct_pb2.Struct): - A struct of custom fields to explain the - insight. Example: "grantedPermissionsCount": - "1000". - last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): - Timestamp of the latest data used to generate - the insight. - observation_period (google.protobuf.duration_pb2.Duration): - Observation period that led to the insight. The source data - used to generate the insight ends at last_refresh_time and - begins at (last_refresh_time - observation_period). - state_info (google.cloud.recommender_v1beta1.types.InsightStateInfo): - Information state and metadata. - category (google.cloud.recommender_v1beta1.types.Insight.Category): - Category being targeted by the insight. - etag (str): - Fingerprint of the Insight. Provides - optimistic locking when updating states. - associated_recommendations (Sequence[google.cloud.recommender_v1beta1.types.Insight.RecommendationReference]): - Recommendations derived from this insight. - """ - class Category(proto.Enum): - r"""Insight category.""" - CATEGORY_UNSPECIFIED = 0 - COST = 1 - SECURITY = 2 - PERFORMANCE = 3 - MANAGEABILITY = 4 - - class RecommendationReference(proto.Message): - r"""Reference to an associated recommendation. - Attributes: - recommendation (str): - Recommendation resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] - """ - - recommendation = proto.Field( - proto.STRING, - number=1, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - description = proto.Field( - proto.STRING, - number=2, - ) - target_resources = proto.RepeatedField( - proto.STRING, - number=9, - ) - insight_subtype = proto.Field( - proto.STRING, - number=10, - ) - content = proto.Field( - proto.MESSAGE, - number=3, - message=struct_pb2.Struct, - ) - last_refresh_time = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - observation_period = proto.Field( - proto.MESSAGE, - number=5, - message=duration_pb2.Duration, - ) - state_info = proto.Field( - proto.MESSAGE, - number=6, - message='InsightStateInfo', - ) - category = proto.Field( - proto.ENUM, - number=7, - enum=Category, - ) - etag = proto.Field( - proto.STRING, - number=11, - ) - associated_recommendations = proto.RepeatedField( - proto.MESSAGE, - number=8, - message=RecommendationReference, - ) - - -class InsightStateInfo(proto.Message): - r"""Information related to insight state. - Attributes: - state (google.cloud.recommender_v1beta1.types.InsightStateInfo.State): - Insight state. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.InsightStateInfo.StateMetadataEntry]): - A map of metadata for the state, provided by - user or automations systems. - """ - class State(proto.Enum): - r"""Represents insight state.""" - STATE_UNSPECIFIED = 0 - ACTIVE = 1 - ACCEPTED = 2 - DISMISSED = 3 - - state = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py deleted file mode 100644 index efe021f..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommendation.py +++ /dev/null @@ -1,420 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.type import money_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1beta1', - manifest={ - 'Recommendation', - 'RecommendationContent', - 'OperationGroup', - 'Operation', - 'ValueMatcher', - 'CostProjection', - 'Impact', - 'RecommendationStateInfo', - }, -) - - -class Recommendation(proto.Message): - r"""A recommendation along with a suggested action. E.g., a - rightsizing recommendation for an underutilized VM, IAM role - recommendations, etc - - Attributes: - name (str): - Name of recommendation. - description (str): - Free-form human readable summary in English. - The maximum length is 500 characters. - recommender_subtype (str): - Contains an identifier for a subtype of recommendations - produced for the same recommender. Subtype is a function of - content and impact, meaning a new subtype might be added - when significant changes to ``content`` or - ``primary_impact.category`` are introduced. See the - Recommenders section to see a list of subtypes for a given - Recommender. - - Examples: For recommender = "google.iam.policy.Recommender", - recommender_subtype can be one of - "REMOVE_ROLE"/"REPLACE_ROLE". - last_refresh_time (google.protobuf.timestamp_pb2.Timestamp): - Last time this recommendation was refreshed - by the system that created it in the first - place. - primary_impact (google.cloud.recommender_v1beta1.types.Impact): - The primary impact that this recommendation - can have while trying to optimize for one - category. - additional_impact (Sequence[google.cloud.recommender_v1beta1.types.Impact]): - Optional set of additional impact that this - recommendation may have when trying to optimize - for the primary category. These may be positive - or negative. - content (google.cloud.recommender_v1beta1.types.RecommendationContent): - Content of the recommendation describing - recommended changes to resources. - state_info (google.cloud.recommender_v1beta1.types.RecommendationStateInfo): - Information for state. Contains state and - metadata. - etag (str): - Fingerprint of the Recommendation. Provides - optimistic locking when updating states. - associated_insights (Sequence[google.cloud.recommender_v1beta1.types.Recommendation.InsightReference]): - Insights that led to this recommendation. - """ - - class InsightReference(proto.Message): - r"""Reference to an associated insight. - Attributes: - insight (str): - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - """ - - insight = proto.Field( - proto.STRING, - number=1, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - description = proto.Field( - proto.STRING, - number=2, - ) - recommender_subtype = proto.Field( - proto.STRING, - number=12, - ) - last_refresh_time = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - primary_impact = proto.Field( - proto.MESSAGE, - number=5, - message='Impact', - ) - additional_impact = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='Impact', - ) - content = proto.Field( - proto.MESSAGE, - number=7, - message='RecommendationContent', - ) - state_info = proto.Field( - proto.MESSAGE, - number=10, - message='RecommendationStateInfo', - ) - etag = proto.Field( - proto.STRING, - number=11, - ) - associated_insights = proto.RepeatedField( - proto.MESSAGE, - number=14, - message=InsightReference, - ) - - -class RecommendationContent(proto.Message): - r"""Contains what resources are changing and how they are - changing. - - Attributes: - operation_groups (Sequence[google.cloud.recommender_v1beta1.types.OperationGroup]): - Operations to one or more Google Cloud - resources grouped in such a way that, all - operations within one group are expected to be - performed atomically and in an order. - """ - - operation_groups = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='OperationGroup', - ) - - -class OperationGroup(proto.Message): - r"""Group of operations that need to be performed atomically. - Attributes: - operations (Sequence[google.cloud.recommender_v1beta1.types.Operation]): - List of operations across one or more - resources that belong to this group. Loosely - based on RFC6902 and should be performed in the - order they appear. - """ - - operations = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Operation', - ) - - -class Operation(proto.Message): - r"""Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: - - - Custom filters for describing partial array patch. - - Extended path values for describing nested arrays. - - Custom fields for describing the resource for which the operation - is being described. - - Allows extension to custom operations not natively supported by - RFC6902. See https://tools.ietf.org/html/rfc6902 for details on - the original RFC. - - Attributes: - action (str): - Type of this operation. Contains one of - 'and', 'remove', 'replace', 'move', 'copy', - 'test' and 'custom' operations. This field is - case-insensitive and always populated. - resource_type (str): - Type of GCP resource being modified/tested. - This field is always populated. Example: - cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - resource (str): - Contains the fully qualified resource name. - This field is always populated. ex: - //cloudresourcemanager.googleapis.com/projects/foo. - path (str): - Path to the target field being operated on. - If the operation is at the resource level, then - path should be "/". This field is always - populated. - source_resource (str): - Can be set with action 'copy' to copy resource configuration - across different resources of the same type. Example: A - resource clone can be done via action = 'copy', path = "/", - from = "/", source_resource = and resource_name = . This - field is empty for all other values of ``action``. - source_path (str): - Can be set with action 'copy' or 'move' to indicate the - source field within resource or source_resource, ignored if - provided for other operation types. - value (google.protobuf.struct_pb2.Value): - Value for the ``path`` field. Will be set for - actions:'add'/'replace'. Maybe set for action: 'test'. - Either this or ``value_matcher`` will be set for 'test' - operation. An exact match must be performed. - value_matcher (google.cloud.recommender_v1beta1.types.ValueMatcher): - Can be set for action 'test' for advanced matching for the - value of 'path' field. Either this or ``value`` will be set - for 'test' operation. - path_filters (Sequence[google.cloud.recommender_v1beta1.types.Operation.PathFiltersEntry]): - Set of filters to apply if ``path`` refers to array elements - or nested array elements in order to narrow down to a single - unique element that is being tested/modified. This is - intended to be an exact match per filter. To perform - advanced matching, use path_value_matchers. - - - Example: { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } - - Example: { "/bindings/*/role": "roles/owner" - "/bindings/*/condition" : null } - - Example: { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", - "y@example.com"] } When both path_filters and - path_value_matchers are set, an implicit AND must be - performed. - path_value_matchers (Sequence[google.cloud.recommender_v1beta1.types.Operation.PathValueMatchersEntry]): - Similar to path_filters, this contains set of filters to - apply if ``path`` field referes to array elements. This is - meant to support value matching beyond exact match. To - perform exact match, use path_filters. When both - path_filters and path_value_matchers are set, an implicit - AND must be performed. - """ - - action = proto.Field( - proto.STRING, - number=1, - ) - resource_type = proto.Field( - proto.STRING, - number=2, - ) - resource = proto.Field( - proto.STRING, - number=3, - ) - path = proto.Field( - proto.STRING, - number=4, - ) - source_resource = proto.Field( - proto.STRING, - number=5, - ) - source_path = proto.Field( - proto.STRING, - number=6, - ) - value = proto.Field( - proto.MESSAGE, - number=7, - oneof='path_value', - message=struct_pb2.Value, - ) - value_matcher = proto.Field( - proto.MESSAGE, - number=10, - oneof='path_value', - message='ValueMatcher', - ) - path_filters = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=8, - message=struct_pb2.Value, - ) - path_value_matchers = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=11, - message='ValueMatcher', - ) - - -class ValueMatcher(proto.Message): - r"""Contains various matching options for values for a GCP - resource field. - - Attributes: - matches_pattern (str): - To be used for full regex matching. The - regular expression is using the Google RE2 - syntax - (https://github.com/google/re2/wiki/Syntax), so - to be used with RE2::FullMatch - """ - - matches_pattern = proto.Field( - proto.STRING, - number=1, - oneof='match_variant', - ) - - -class CostProjection(proto.Message): - r"""Contains metadata about how much money a recommendation can - save or incur. - - Attributes: - cost (google.type.money_pb2.Money): - An approximate projection on amount saved or - amount incurred. Negative cost units indicate - cost savings and positive cost units indicate - increase. See google.type.Money documentation - for positive/negative units. - duration (google.protobuf.duration_pb2.Duration): - Duration for which this cost applies. - """ - - cost = proto.Field( - proto.MESSAGE, - number=1, - message=money_pb2.Money, - ) - duration = proto.Field( - proto.MESSAGE, - number=2, - message=duration_pb2.Duration, - ) - - -class Impact(proto.Message): - r"""Contains the impact a recommendation can have for a given - category. - - Attributes: - category (google.cloud.recommender_v1beta1.types.Impact.Category): - Category that is being targeted. - cost_projection (google.cloud.recommender_v1beta1.types.CostProjection): - Use with CategoryType.COST - """ - class Category(proto.Enum): - r"""The category of the impact.""" - CATEGORY_UNSPECIFIED = 0 - COST = 1 - SECURITY = 2 - PERFORMANCE = 3 - MANAGEABILITY = 4 - - category = proto.Field( - proto.ENUM, - number=1, - enum=Category, - ) - cost_projection = proto.Field( - proto.MESSAGE, - number=100, - oneof='projection', - message='CostProjection', - ) - - -class RecommendationStateInfo(proto.Message): - r"""Information for state. Contains state and metadata. - Attributes: - state (google.cloud.recommender_v1beta1.types.RecommendationStateInfo.State): - The state of the recommendation, Eg ACTIVE, - SUCCEEDED, FAILED. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.RecommendationStateInfo.StateMetadataEntry]): - A map of metadata for the state, provided by - user or automations systems. - """ - class State(proto.Enum): - r"""Represents Recommendation State.""" - STATE_UNSPECIFIED = 0 - ACTIVE = 1 - CLAIMED = 6 - SUCCEEDED = 3 - FAILED = 4 - DISMISSED = 5 - - state = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py b/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py deleted file mode 100644 index 2aa4b13..0000000 --- a/owl-bot-staging/v1beta1/google/cloud/recommender_v1beta1/types/recommender_service.py +++ /dev/null @@ -1,335 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation - - -__protobuf__ = proto.module( - package='google.cloud.recommender.v1beta1', - manifest={ - 'ListInsightsRequest', - 'ListInsightsResponse', - 'GetInsightRequest', - 'MarkInsightAcceptedRequest', - 'ListRecommendationsRequest', - 'ListRecommendationsResponse', - 'GetRecommendationRequest', - 'MarkRecommendationClaimedRequest', - 'MarkRecommendationSucceededRequest', - 'MarkRecommendationFailedRequest', - }, -) - - -class ListInsightsRequest(proto.Message): - r"""Request for the ``ListInsights`` method. - Attributes: - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID - refers to supported insight types: - https://cloud.google.com/recommender/docs/insights/insight-types. - page_size (int): - Optional. The maximum number of results to - return from this request. Non-positive values - are ignored. If not specified, the server will - determine the number of results to return. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters must be - identical to those in the previous call. - filter (str): - Optional. Filter expression to restrict the insights - returned. Supported filter fields: state Eg: - \`state:"DISMISSED" or state:"ACTIVE". - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - - -class ListInsightsResponse(proto.Message): - r"""Response to the ``ListInsights`` method. - Attributes: - insights (Sequence[google.cloud.recommender_v1beta1.types.Insight]): - The set of insights for the ``parent`` resource. - next_page_token (str): - A token that can be used to request the next - page of results. This field is empty if there - are no additional results. - """ - - @property - def raw_page(self): - return self - - insights = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=insight.Insight, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetInsightRequest(proto.Message): - r"""Request to the ``GetInsight`` method. - Attributes: - name (str): - Required. Name of the insight. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class MarkInsightAcceptedRequest(proto.Message): - r"""Request for the ``MarkInsightAccepted`` method. - Attributes: - name (str): - Required. Name of the insight. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest.StateMetadataEntry]): - Optional. State properties user wish to include with this - state. Full replace of the current state_metadata. - etag (str): - Required. Fingerprint of the Insight. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class ListRecommendationsRequest(proto.Message): - r"""Request for the ``ListRecommendations`` method. - Attributes: - parent (str): - Required. The container resource on which to execute the - request. Acceptable formats: - - 1. - - "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - - LOCATION here refers to GCP Locations: - https://cloud.google.com/about/locations/ RECOMMENDER_ID - refers to supported recommenders: - https://cloud.google.com/recommender/docs/recommenders. - page_size (int): - Optional. The maximum number of results to - return from this request. Non-positive values - are ignored. If not specified, the server will - determine the number of results to return. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters must be - identical to those in the previous call. - filter (str): - Filter expression to restrict the recommendations returned. - Supported filter fields: state_info.state Eg: - \`state_info.state:"DISMISSED" or state_info.state:"FAILED". - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=5, - ) - - -class ListRecommendationsResponse(proto.Message): - r"""Response to the ``ListRecommendations`` method. - Attributes: - recommendations (Sequence[google.cloud.recommender_v1beta1.types.Recommendation]): - The set of recommendations for the ``parent`` resource. - next_page_token (str): - A token that can be used to request the next - page of results. This field is empty if there - are no additional results. - """ - - @property - def raw_page(self): - return self - - recommendations = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=recommendation.Recommendation, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class GetRecommendationRequest(proto.Message): - r"""Request to the ``GetRecommendation`` method. - Attributes: - name (str): - Required. Name of the recommendation. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class MarkRecommendationClaimedRequest(proto.Message): - r"""Request for the ``MarkRecommendationClaimed`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class MarkRecommendationSucceededRequest(proto.Message): - r"""Request for the ``MarkRecommendationSucceeded`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -class MarkRecommendationFailedRequest(proto.Message): - r"""Request for the ``MarkRecommendationFailed`` Method. - Attributes: - name (str): - Required. Name of the recommendation. - state_metadata (Sequence[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest.StateMetadataEntry]): - State properties to include with this state. Overwrites any - existing ``state_metadata``. Keys must match the regex - /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex - /^[a-zA-Z0-9_./-]{0,255}$/. - etag (str): - Required. Fingerprint of the Recommendation. - Provides optimistic locking. - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - state_metadata = proto.MapField( - proto.STRING, - proto.STRING, - number=2, - ) - etag = proto.Field( - proto.STRING, - number=3, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/mypy.ini b/owl-bot-staging/v1beta1/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1beta1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1beta1/noxfile.py b/owl-bot-staging/v1beta1/noxfile.py deleted file mode 100644 index f727576..0000000 --- a/owl-bot-staging/v1beta1/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/recommender_v1beta1/', - '--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', 'types-pkg_resources') - 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/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py b/owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py deleted file mode 100644 index c0fe445..0000000 --- a/owl-bot-staging/v1beta1/scripts/fixup_recommender_v1beta1_keywords.py +++ /dev/null @@ -1,183 +0,0 @@ -#! /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 recommenderCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'get_insight': ('name', ), - 'get_recommendation': ('name', ), - 'list_insights': ('parent', 'page_size', 'page_token', 'filter', ), - 'list_recommendations': ('parent', 'page_size', 'page_token', 'filter', ), - 'mark_insight_accepted': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_claimed': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_failed': ('name', 'etag', 'state_metadata', ), - 'mark_recommendation_succeeded': ('name', 'etag', 'state_metadata', ), - } - - 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=recommenderCallTransformer(), -): - """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 recommender client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1beta1/setup.py b/owl-bot-staging/v1beta1/setup.py deleted file mode 100644 index fc7260d..0000000 --- a/owl-bot-staging/v1beta1/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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-recommender', - 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.27.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - 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', - 'Programming Language :: Python :: 3.9', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1beta1/tests/__init__.py b/owl-bot-staging/v1beta1/tests/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1beta1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/__init__.py b/owl-bot-staging/v1beta1/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py b/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py deleted file mode 100644 index eb54dc6..0000000 --- a/owl-bot-staging/v1beta1/tests/unit/gapic/recommender_v1beta1/test_recommender.py +++ /dev/null @@ -1,3377 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.recommender_v1beta1.services.recommender import RecommenderAsyncClient -from google.cloud.recommender_v1beta1.services.recommender import RecommenderClient -from google.cloud.recommender_v1beta1.services.recommender import pagers -from google.cloud.recommender_v1beta1.services.recommender import transports -from google.cloud.recommender_v1beta1.services.recommender.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.recommender_v1beta1.types import insight -from google.cloud.recommender_v1beta1.types import recommendation -from google.cloud.recommender_v1beta1.types import recommender_service -from google.oauth2 import service_account -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import struct_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the 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", -) - -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 RecommenderClient._get_default_mtls_endpoint(None) is None - assert RecommenderClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert RecommenderClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - RecommenderClient, - RecommenderAsyncClient, -]) -def test_recommender_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'recommender.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.RecommenderGrpcTransport, "grpc"), - (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - RecommenderClient, - RecommenderAsyncClient, -]) -def test_recommender_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - 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 == 'recommender.googleapis.com:443' - - -def test_recommender_client_get_transport_class(): - transport = RecommenderClient.get_transport_class() - available_transports = [ - transports.RecommenderGrpcTransport, - ] - assert transport in available_transports - - transport = RecommenderClient.get_transport_class("grpc") - assert transport == transports.RecommenderGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) -@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) -def test_recommender_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(RecommenderClient, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(RecommenderClient, '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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "true"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc", "false"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(RecommenderClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderClient)) -@mock.patch.object(RecommenderAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecommenderAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_recommender_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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - # 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, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_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, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecommenderClient, transports.RecommenderGrpcTransport, "grpc"), - (RecommenderAsyncClient, transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recommender_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, - always_use_jwt_access=True, - ) - - -def test_recommender_client_client_options_from_dict(): - with mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = RecommenderClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_list_insights(transport: str = 'grpc', request_type=recommender_service.ListInsightsRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_insights(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListInsightsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_insights_from_dict(): - test_list_insights(request_type=dict) - - -def test_list_insights_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - client.list_insights() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - -@pytest.mark.asyncio -async def test_list_insights_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListInsightsRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_insights(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListInsightsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListInsightsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_insights_async_from_dict(): - await test_list_insights_async(request_type=dict) - - -def test_list_insights_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListInsightsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - call.return_value = recommender_service.ListInsightsResponse() - client.list_insights(request) - - # Establish that the 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_insights_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListInsightsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) - await client.list_insights(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_insights_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_insights( - 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_insights_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_insights( - recommender_service.ListInsightsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_insights_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListInsightsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListInsightsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_insights( - 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_insights_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_insights( - recommender_service.ListInsightsRequest(), - parent='parent_value', - ) - - -def test_list_insights_pager(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_insights(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, insight.Insight) - for i in results) - -def test_list_insights_pages(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - pages = list(client.list_insights(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_insights_async_pager(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_insights(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, insight.Insight) - for i in responses) - -@pytest.mark.asyncio -async def test_list_insights_async_pages(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_insights), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - insight.Insight(), - ], - next_page_token='abc', - ), - recommender_service.ListInsightsResponse( - insights=[], - next_page_token='def', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - ], - next_page_token='ghi', - ), - recommender_service.ListInsightsResponse( - insights=[ - insight.Insight(), - insight.Insight(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_insights(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_insight(transport: str = 'grpc', request_type=recommender_service.GetInsightRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - ) - response = client.get_insight(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -def test_get_insight_from_dict(): - test_get_insight(request_type=dict) - - -def test_get_insight_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - client.get_insight() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - -@pytest.mark.asyncio -async def test_get_insight_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetInsightRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - )) - response = await client.get_insight(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetInsightRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_insight_async_from_dict(): - await test_get_insight_async(request_type=dict) - - -def test_get_insight_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetInsightRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - call.return_value = insight.Insight() - client.get_insight(request) - - # Establish that the 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_insight_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetInsightRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - await client.get_insight(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_insight_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_insight( - 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_insight_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_insight( - recommender_service.GetInsightRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_insight_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_insight), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_insight( - 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_insight_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_insight( - recommender_service.GetInsightRequest(), - name='name_value', - ) - - -def test_mark_insight_accepted(transport: str = 'grpc', request_type=recommender_service.MarkInsightAcceptedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - ) - response = client.mark_insight_accepted(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -def test_mark_insight_accepted_from_dict(): - test_mark_insight_accepted(request_type=dict) - - -def test_mark_insight_accepted_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - client.mark_insight_accepted() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkInsightAcceptedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight( - name='name_value', - description='description_value', - target_resources=['target_resources_value'], - insight_subtype='insight_subtype_value', - category=insight.Insight.Category.COST, - etag='etag_value', - )) - response = await client.mark_insight_accepted(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkInsightAcceptedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, insight.Insight) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.target_resources == ['target_resources_value'] - assert response.insight_subtype == 'insight_subtype_value' - assert response.category == insight.Insight.Category.COST - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_async_from_dict(): - await test_mark_insight_accepted_async(request_type=dict) - - -def test_mark_insight_accepted_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkInsightAcceptedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - call.return_value = insight.Insight() - client.mark_insight_accepted(request) - - # Establish that the 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_mark_insight_accepted_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkInsightAcceptedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - await client.mark_insight_accepted(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_mark_insight_accepted_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_insight_accepted( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_insight_accepted_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_insight_accepted( - recommender_service.MarkInsightAcceptedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_insight_accepted), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = insight.Insight() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(insight.Insight()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_insight_accepted( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_insight_accepted_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_insight_accepted( - recommender_service.MarkInsightAcceptedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_list_recommendations(transport: str = 'grpc', request_type=recommender_service.ListRecommendationsRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_recommendations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRecommendationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_recommendations_from_dict(): - test_list_recommendations(request_type=dict) - - -def test_list_recommendations_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - client.list_recommendations() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - -@pytest.mark.asyncio -async def test_list_recommendations_async(transport: str = 'grpc_asyncio', request_type=recommender_service.ListRecommendationsRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_recommendations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.ListRecommendationsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRecommendationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_recommendations_async_from_dict(): - await test_list_recommendations_async(request_type=dict) - - -def test_list_recommendations_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListRecommendationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - call.return_value = recommender_service.ListRecommendationsResponse() - client.list_recommendations(request) - - # Establish that the 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_recommendations_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.ListRecommendationsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) - await client.list_recommendations(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_recommendations_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_recommendations( - parent='parent_value', - filter='filter_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' - assert args[0].filter == 'filter_value' - - -def test_list_recommendations_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_recommendations( - recommender_service.ListRecommendationsRequest(), - parent='parent_value', - filter='filter_value', - ) - - -@pytest.mark.asyncio -async def test_list_recommendations_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommender_service.ListRecommendationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommender_service.ListRecommendationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_recommendations( - parent='parent_value', - filter='filter_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' - assert args[0].filter == 'filter_value' - - -@pytest.mark.asyncio -async def test_list_recommendations_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_recommendations( - recommender_service.ListRecommendationsRequest(), - parent='parent_value', - filter='filter_value', - ) - - -def test_list_recommendations_pager(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_recommendations(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, recommendation.Recommendation) - for i in results) - -def test_list_recommendations_pages(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - pages = list(client.list_recommendations(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_recommendations_async_pager(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_recommendations(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, recommendation.Recommendation) - for i in responses) - -@pytest.mark.asyncio -async def test_list_recommendations_async_pages(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_recommendations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - next_page_token='abc', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[], - next_page_token='def', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - ], - next_page_token='ghi', - ), - recommender_service.ListRecommendationsResponse( - recommendations=[ - recommendation.Recommendation(), - recommendation.Recommendation(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_recommendations(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_recommendation(transport: str = 'grpc', request_type=recommender_service.GetRecommendationRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.get_recommendation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_get_recommendation_from_dict(): - test_get_recommendation(request_type=dict) - - -def test_get_recommendation_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - client.get_recommendation() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - -@pytest.mark.asyncio -async def test_get_recommendation_async(transport: str = 'grpc_asyncio', request_type=recommender_service.GetRecommendationRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an 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_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.get_recommendation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.GetRecommendationRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_get_recommendation_async_from_dict(): - await test_get_recommendation_async(request_type=dict) - - -def test_get_recommendation_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetRecommendationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.get_recommendation(request) - - # Establish that the 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_recommendation_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.GetRecommendationRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.get_recommendation(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_recommendation_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_recommendation( - 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_recommendation_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_recommendation( - recommender_service.GetRecommendationRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_recommendation_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_recommendation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_recommendation( - 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_recommendation_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_recommendation( - recommender_service.GetRecommendationRequest(), - name='name_value', - ) - - -def test_mark_recommendation_claimed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationClaimedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_claimed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_claimed_from_dict(): - test_mark_recommendation_claimed(request_type=dict) - - -def test_mark_recommendation_claimed_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - client.mark_recommendation_claimed() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationClaimedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_claimed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationClaimedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_async_from_dict(): - await test_mark_recommendation_claimed_async(request_type=dict) - - -def test_mark_recommendation_claimed_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationClaimedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_claimed(request) - - # Establish that the 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_mark_recommendation_claimed_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationClaimedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_claimed(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_mark_recommendation_claimed_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_claimed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_claimed_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_claimed( - recommender_service.MarkRecommendationClaimedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_claimed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_claimed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_claimed_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_claimed( - recommender_service.MarkRecommendationClaimedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_mark_recommendation_succeeded(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationSucceededRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_succeeded(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_succeeded_from_dict(): - test_mark_recommendation_succeeded(request_type=dict) - - -def test_mark_recommendation_succeeded_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - client.mark_recommendation_succeeded() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationSucceededRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_succeeded(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationSucceededRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_async_from_dict(): - await test_mark_recommendation_succeeded_async(request_type=dict) - - -def test_mark_recommendation_succeeded_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationSucceededRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_succeeded(request) - - # Establish that the 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_mark_recommendation_succeeded_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationSucceededRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_succeeded(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_mark_recommendation_succeeded_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_succeeded( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_succeeded_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_succeeded( - recommender_service.MarkRecommendationSucceededRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_succeeded), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_succeeded( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_succeeded_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_succeeded( - recommender_service.MarkRecommendationSucceededRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_mark_recommendation_failed(transport: str = 'grpc', request_type=recommender_service.MarkRecommendationFailedRequest): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - ) - response = client.mark_recommendation_failed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -def test_mark_recommendation_failed_from_dict(): - test_mark_recommendation_failed(request_type=dict) - - -def test_mark_recommendation_failed_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 = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - client.mark_recommendation_failed() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_async(transport: str = 'grpc_asyncio', request_type=recommender_service.MarkRecommendationFailedRequest): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation( - name='name_value', - description='description_value', - recommender_subtype='recommender_subtype_value', - etag='etag_value', - )) - response = await client.mark_recommendation_failed(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recommender_service.MarkRecommendationFailedRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recommendation.Recommendation) - assert response.name == 'name_value' - assert response.description == 'description_value' - assert response.recommender_subtype == 'recommender_subtype_value' - assert response.etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_async_from_dict(): - await test_mark_recommendation_failed_async(request_type=dict) - - -def test_mark_recommendation_failed_field_headers(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationFailedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - call.return_value = recommendation.Recommendation() - client.mark_recommendation_failed(request) - - # Establish that the 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_mark_recommendation_failed_field_headers_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = recommender_service.MarkRecommendationFailedRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - await client.mark_recommendation_failed(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_mark_recommendation_failed_flattened(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.mark_recommendation_failed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -def test_mark_recommendation_failed_flattened_error(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.mark_recommendation_failed( - recommender_service.MarkRecommendationFailedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_flattened_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.mark_recommendation_failed), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recommendation.Recommendation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recommendation.Recommendation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.mark_recommendation_failed( - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_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].state_metadata == {'key_value': 'value_value'} - assert args[0].etag == 'etag_value' - - -@pytest.mark.asyncio -async def test_mark_recommendation_failed_flattened_error_async(): - client = RecommenderAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.mark_recommendation_failed( - recommender_service.MarkRecommendationFailedRequest(), - name='name_value', - state_metadata={'key_value': 'value_value'}, - etag='etag_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = RecommenderClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.RecommenderGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.RecommenderGrpcTransport, - ) - -def test_recommender_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_recommender_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'list_insights', - 'get_insight', - 'mark_insight_accepted', - 'list_recommendations', - 'get_recommendation', - 'mark_recommendation_claimed', - 'mark_recommendation_succeeded', - 'mark_recommendation_failed', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_recommender_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport( - 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_recommender_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport( - 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_recommender_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecommenderTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_recommender_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecommenderClient() - 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_recommender_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - RecommenderClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_recommender_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_recommender_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(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_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.RecommenderGrpcTransport, grpc_helpers), - (transports.RecommenderGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_recommender_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "recommender.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="recommender.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_recommender_host_no_port(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com'), - ) - assert client.transport._host == 'recommender.googleapis.com:443' - - -def test_recommender_host_with_port(): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recommender.googleapis.com:8000'), - ) - assert client.transport._host == 'recommender.googleapis.com:8000' - -def test_recommender_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecommenderGrpcTransport( - 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_recommender_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecommenderGrpcAsyncIOTransport( - 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.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport]) -def test_recommender_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_insight_path(): - project = "squid" - location = "clam" - insight_type = "whelk" - insight = "octopus" - expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}".format(project=project, location=location, insight_type=insight_type, insight=insight, ) - actual = RecommenderClient.insight_path(project, location, insight_type, insight) - assert expected == actual - - -def test_parse_insight_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - "insight_type": "cuttlefish", - "insight": "mussel", - } - path = RecommenderClient.insight_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_insight_path(path) - assert expected == actual - -def test_insight_type_path(): - project = "winkle" - location = "nautilus" - insight_type = "scallop" - expected = "projects/{project}/locations/{location}/insightTypes/{insight_type}".format(project=project, location=location, insight_type=insight_type, ) - actual = RecommenderClient.insight_type_path(project, location, insight_type) - assert expected == actual - - -def test_parse_insight_type_path(): - expected = { - "project": "abalone", - "location": "squid", - "insight_type": "clam", - } - path = RecommenderClient.insight_type_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_insight_type_path(path) - assert expected == actual - -def test_recommendation_path(): - project = "whelk" - location = "octopus" - recommender = "oyster" - recommendation = "nudibranch" - expected = "projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}".format(project=project, location=location, recommender=recommender, recommendation=recommendation, ) - actual = RecommenderClient.recommendation_path(project, location, recommender, recommendation) - assert expected == actual - - -def test_parse_recommendation_path(): - expected = { - "project": "cuttlefish", - "location": "mussel", - "recommender": "winkle", - "recommendation": "nautilus", - } - path = RecommenderClient.recommendation_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_recommendation_path(path) - assert expected == actual - -def test_recommender_path(): - project = "scallop" - location = "abalone" - recommender = "squid" - expected = "projects/{project}/locations/{location}/recommenders/{recommender}".format(project=project, location=location, recommender=recommender, ) - actual = RecommenderClient.recommender_path(project, location, recommender) - assert expected == actual - - -def test_parse_recommender_path(): - expected = { - "project": "clam", - "location": "whelk", - "recommender": "octopus", - } - path = RecommenderClient.recommender_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_recommender_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "oyster" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = RecommenderClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "nudibranch", - } - path = RecommenderClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "cuttlefish" - expected = "folders/{folder}".format(folder=folder, ) - actual = RecommenderClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "mussel", - } - path = RecommenderClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "winkle" - expected = "organizations/{organization}".format(organization=organization, ) - actual = RecommenderClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nautilus", - } - path = RecommenderClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "scallop" - expected = "projects/{project}".format(project=project, ) - actual = RecommenderClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "abalone", - } - path = RecommenderClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "squid" - location = "clam" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = RecommenderClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "whelk", - "location": "octopus", - } - path = RecommenderClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = RecommenderClient.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.RecommenderTransport, '_prep_wrapped_messages') as prep: - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.RecommenderTransport, '_prep_wrapped_messages') as prep: - transport_class = RecommenderClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/tests/unit/gapic/recommender_v1/test_recommender.py b/tests/unit/gapic/recommender_v1/test_recommender.py index 7d105b1..4ff21c4 100644 --- a/tests/unit/gapic/recommender_v1/test_recommender.py +++ b/tests/unit/gapic/recommender_v1/test_recommender.py @@ -118,16 +118,6 @@ def test_recommender_client_from_service_account_info(client_class): assert client.transport._host == "recommender.googleapis.com:443" -@pytest.mark.parametrize("client_class", [RecommenderClient, RecommenderAsyncClient,]) -def test_recommender_client_service_account_always_use_jwt(client_class): - with mock.patch.object( - service_account.Credentials, "with_always_use_jwt_access", create=True - ) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_not_called() - - @pytest.mark.parametrize( "transport_class,transport_name", [ @@ -135,7 +125,7 @@ def test_recommender_client_service_account_always_use_jwt(client_class): (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_recommender_client_service_account_always_use_jwt_true( +def test_recommender_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -145,6 +135,13 @@ def test_recommender_client_service_account_always_use_jwt_true( transport = transport_class(credentials=creds, always_use_jwt_access=True) use_jwt.assert_called_once_with(True) + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + @pytest.mark.parametrize("client_class", [RecommenderClient, RecommenderAsyncClient,]) def test_recommender_client_from_service_account_file(client_class): @@ -221,6 +218,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -237,6 +235,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -253,6 +252,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has @@ -281,6 +281,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id="octopus", client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -345,6 +346,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case ADC client cert is provided. Whether client cert is used depends on @@ -378,6 +380,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case client_cert_source and ADC client cert are not provided. @@ -399,6 +402,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -429,6 +433,7 @@ def test_recommender_client_client_options_scopes( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -459,6 +464,7 @@ def test_recommender_client_client_options_credentials_file( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -476,6 +482,7 @@ def test_recommender_client_client_options_from_dict(): client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) diff --git a/tests/unit/gapic/recommender_v1beta1/test_recommender.py b/tests/unit/gapic/recommender_v1beta1/test_recommender.py index 7d73e8c..b8905f8 100644 --- a/tests/unit/gapic/recommender_v1beta1/test_recommender.py +++ b/tests/unit/gapic/recommender_v1beta1/test_recommender.py @@ -118,16 +118,6 @@ def test_recommender_client_from_service_account_info(client_class): assert client.transport._host == "recommender.googleapis.com:443" -@pytest.mark.parametrize("client_class", [RecommenderClient, RecommenderAsyncClient,]) -def test_recommender_client_service_account_always_use_jwt(client_class): - with mock.patch.object( - service_account.Credentials, "with_always_use_jwt_access", create=True - ) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_not_called() - - @pytest.mark.parametrize( "transport_class,transport_name", [ @@ -135,7 +125,7 @@ def test_recommender_client_service_account_always_use_jwt(client_class): (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_recommender_client_service_account_always_use_jwt_true( +def test_recommender_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -145,6 +135,13 @@ def test_recommender_client_service_account_always_use_jwt_true( transport = transport_class(credentials=creds, always_use_jwt_access=True) use_jwt.assert_called_once_with(True) + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + @pytest.mark.parametrize("client_class", [RecommenderClient, RecommenderAsyncClient,]) def test_recommender_client_from_service_account_file(client_class): @@ -221,6 +218,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -237,6 +235,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -253,6 +252,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has @@ -281,6 +281,7 @@ def test_recommender_client_client_options( client_cert_source_for_mtls=None, quota_project_id="octopus", client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -345,6 +346,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case ADC client cert is provided. Whether client cert is used depends on @@ -378,6 +380,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case client_cert_source and ADC client cert are not provided. @@ -399,6 +402,7 @@ def test_recommender_client_mtls_env_auto( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -429,6 +433,7 @@ def test_recommender_client_client_options_scopes( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -459,6 +464,7 @@ def test_recommender_client_client_options_credentials_file( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -476,6 +482,7 @@ def test_recommender_client_client_options_from_dict(): client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, )