From 19d3e4150776f7095a29b905c2bb438a9cc703df Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:05:56 +0000 Subject: [PATCH] docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: https://github.com/googleapis/googleapis/commit/8a085aeddfa010af5bcef090827aac5255383d7e Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 --- owl-bot-staging/v1beta1/.coveragerc | 13 + owl-bot-staging/v1beta1/.flake8 | 33 + owl-bot-staging/v1beta1/MANIFEST.in | 2 + owl-bot-staging/v1beta1/README.rst | 49 + owl-bot-staging/v1beta1/docs/conf.py | 376 +++ owl-bot-staging/v1beta1/docs/index.rst | 7 + .../private_catalog.rst | 10 + .../docs/privatecatalog_v1beta1/services.rst | 6 + .../docs/privatecatalog_v1beta1/types.rst | 6 + .../google/cloud/privatecatalog/__init__.py | 53 + .../cloud/privatecatalog/gapic_version.py | 16 + .../google/cloud/privatecatalog/py.typed | 2 + .../cloud/privatecatalog_v1beta1/__init__.py | 54 + .../gapic_metadata.json | 73 + .../privatecatalog_v1beta1/gapic_version.py | 16 + .../cloud/privatecatalog_v1beta1/py.typed | 2 + .../services/__init__.py | 15 + .../services/private_catalog/__init__.py | 22 + .../services/private_catalog/async_client.py | 513 +++ .../services/private_catalog/client.py | 738 ++++ .../services/private_catalog/pagers.py | 381 +++ .../private_catalog/transports/__init__.py | 38 + .../private_catalog/transports/base.py | 176 + .../private_catalog/transports/grpc.py | 343 ++ .../transports/grpc_asyncio.py | 342 ++ .../private_catalog/transports/rest.py | 562 +++ .../privatecatalog_v1beta1/types/__init__.py | 46 + .../types/private_catalog.py | 824 +++++ owl-bot-staging/v1beta1/mypy.ini | 3 + owl-bot-staging/v1beta1/noxfile.py | 184 + ...d_private_catalog_search_catalogs_async.py | 53 + ...ed_private_catalog_search_catalogs_sync.py | 53 + ...d_private_catalog_search_products_async.py | 53 + ...ed_private_catalog_search_products_sync.py | 53 + ...d_private_catalog_search_versions_async.py | 54 + ...ed_private_catalog_search_versions_sync.py | 54 + ...a_google.cloud.privatecatalog.v1beta1.json | 474 +++ .../fixup_privatecatalog_v1beta1_keywords.py | 178 + owl-bot-staging/v1beta1/setup.py | 90 + .../v1beta1/testing/constraints-3.10.txt | 6 + .../v1beta1/testing/constraints-3.11.txt | 6 + .../v1beta1/testing/constraints-3.12.txt | 6 + .../v1beta1/testing/constraints-3.7.txt | 9 + .../v1beta1/testing/constraints-3.8.txt | 6 + .../v1beta1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v1beta1/tests/__init__.py | 16 + .../v1beta1/tests/unit/__init__.py | 16 + .../v1beta1/tests/unit/gapic/__init__.py | 16 + .../gapic/privatecatalog_v1beta1/__init__.py | 16 + .../test_private_catalog.py | 3000 +++++++++++++++++ 50 files changed, 9070 insertions(+) create mode 100644 owl-bot-staging/v1beta1/.coveragerc create mode 100644 owl-bot-staging/v1beta1/.flake8 create mode 100644 owl-bot-staging/v1beta1/MANIFEST.in create mode 100644 owl-bot-staging/v1beta1/README.rst create mode 100644 owl-bot-staging/v1beta1/docs/conf.py create mode 100644 owl-bot-staging/v1beta1/docs/index.rst create mode 100644 owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/private_catalog.rst create mode 100644 owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/services.rst create mode 100644 owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/types.rst create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog/gapic_version.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_metadata.json create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_version.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/py.typed create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/async_client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/client.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/pagers.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/base.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/rest.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/__init__.py create mode 100644 owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/private_catalog.py create mode 100644 owl-bot-staging/v1beta1/mypy.ini create mode 100644 owl-bot-staging/v1beta1/noxfile.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py create mode 100644 owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.privatecatalog.v1beta1.json create mode 100644 owl-bot-staging/v1beta1/scripts/fixup_privatecatalog_v1beta1_keywords.py create mode 100644 owl-bot-staging/v1beta1/setup.py create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v1beta1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v1beta1/tests/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/__init__.py create mode 100644 owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/test_private_catalog.py diff --git a/owl-bot-staging/v1beta1/.coveragerc b/owl-bot-staging/v1beta1/.coveragerc new file mode 100644 index 0000000..f654502 --- /dev/null +++ b/owl-bot-staging/v1beta1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/privatecatalog/__init__.py + google/cloud/privatecatalog/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1beta1/.flake8 b/owl-bot-staging/v1beta1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v1beta1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1beta1/MANIFEST.in b/owl-bot-staging/v1beta1/MANIFEST.in new file mode 100644 index 0000000..048f040 --- /dev/null +++ b/owl-bot-staging/v1beta1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/privatecatalog *.py +recursive-include google/cloud/privatecatalog_v1beta1 *.py diff --git a/owl-bot-staging/v1beta1/README.rst b/owl-bot-staging/v1beta1/README.rst new file mode 100644 index 0000000..47cd44b --- /dev/null +++ b/owl-bot-staging/v1beta1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Privatecatalog 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 Privatecatalog 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..36632c9 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-private-catalog documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-private-catalog" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-private-catalog-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-private-catalog.tex", + u"google-cloud-private-catalog Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-private-catalog", + u"Google Cloud Privatecatalog Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-private-catalog", + u"google-cloud-private-catalog Documentation", + author, + "google-cloud-private-catalog", + "GAPIC library for Google Cloud Privatecatalog 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..c7ba045 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + privatecatalog_v1beta1/services + privatecatalog_v1beta1/types diff --git a/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/private_catalog.rst b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/private_catalog.rst new file mode 100644 index 0000000..63e9932 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/private_catalog.rst @@ -0,0 +1,10 @@ +PrivateCatalog +-------------------------------- + +.. automodule:: google.cloud.privatecatalog_v1beta1.services.private_catalog + :members: + :inherited-members: + +.. automodule:: google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/services.rst b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/services.rst new file mode 100644 index 0000000..052bc30 --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Privatecatalog v1beta1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + private_catalog diff --git a/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/types.rst b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/types.rst new file mode 100644 index 0000000..bfff37c --- /dev/null +++ b/owl-bot-staging/v1beta1/docs/privatecatalog_v1beta1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Privatecatalog v1beta1 API +================================================= + +.. automodule:: google.cloud.privatecatalog_v1beta1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/__init__.py new file mode 100644 index 0000000..d7c1e29 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/__init__.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.privatecatalog import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.privatecatalog_v1beta1.services.private_catalog.client import PrivateCatalogClient +from google.cloud.privatecatalog_v1beta1.services.private_catalog.async_client import PrivateCatalogAsyncClient + +from google.cloud.privatecatalog_v1beta1.types.private_catalog import AssetReference +from google.cloud.privatecatalog_v1beta1.types.private_catalog import Catalog +from google.cloud.privatecatalog_v1beta1.types.private_catalog import GcsSource +from google.cloud.privatecatalog_v1beta1.types.private_catalog import GitSource +from google.cloud.privatecatalog_v1beta1.types.private_catalog import Inputs +from google.cloud.privatecatalog_v1beta1.types.private_catalog import Product +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchCatalogsRequest +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchCatalogsResponse +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchProductsRequest +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchProductsResponse +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchVersionsRequest +from google.cloud.privatecatalog_v1beta1.types.private_catalog import SearchVersionsResponse +from google.cloud.privatecatalog_v1beta1.types.private_catalog import Version + +__all__ = ('PrivateCatalogClient', + 'PrivateCatalogAsyncClient', + 'AssetReference', + 'Catalog', + 'GcsSource', + 'GitSource', + 'Inputs', + 'Product', + 'SearchCatalogsRequest', + 'SearchCatalogsResponse', + 'SearchProductsRequest', + 'SearchProductsResponse', + 'SearchVersionsRequest', + 'SearchVersionsResponse', + 'Version', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog/py.typed b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/py.typed new file mode 100644 index 0000000..dcec715 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-private-catalog package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/__init__.py new file mode 100644 index 0000000..f18a72e --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/__init__.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.privatecatalog_v1beta1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.private_catalog import PrivateCatalogClient +from .services.private_catalog import PrivateCatalogAsyncClient + +from .types.private_catalog import AssetReference +from .types.private_catalog import Catalog +from .types.private_catalog import GcsSource +from .types.private_catalog import GitSource +from .types.private_catalog import Inputs +from .types.private_catalog import Product +from .types.private_catalog import SearchCatalogsRequest +from .types.private_catalog import SearchCatalogsResponse +from .types.private_catalog import SearchProductsRequest +from .types.private_catalog import SearchProductsResponse +from .types.private_catalog import SearchVersionsRequest +from .types.private_catalog import SearchVersionsResponse +from .types.private_catalog import Version + +__all__ = ( + 'PrivateCatalogAsyncClient', +'AssetReference', +'Catalog', +'GcsSource', +'GitSource', +'Inputs', +'PrivateCatalogClient', +'Product', +'SearchCatalogsRequest', +'SearchCatalogsResponse', +'SearchProductsRequest', +'SearchProductsResponse', +'SearchVersionsRequest', +'SearchVersionsResponse', +'Version', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_metadata.json b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_metadata.json new file mode 100644 index 0000000..b966bcf --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_metadata.json @@ -0,0 +1,73 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.privatecatalog_v1beta1", + "protoPackage": "google.cloud.privatecatalog.v1beta1", + "schema": "1.0", + "services": { + "PrivateCatalog": { + "clients": { + "grpc": { + "libraryClient": "PrivateCatalogClient", + "rpcs": { + "SearchCatalogs": { + "methods": [ + "search_catalogs" + ] + }, + "SearchProducts": { + "methods": [ + "search_products" + ] + }, + "SearchVersions": { + "methods": [ + "search_versions" + ] + } + } + }, + "grpc-async": { + "libraryClient": "PrivateCatalogAsyncClient", + "rpcs": { + "SearchCatalogs": { + "methods": [ + "search_catalogs" + ] + }, + "SearchProducts": { + "methods": [ + "search_products" + ] + }, + "SearchVersions": { + "methods": [ + "search_versions" + ] + } + } + }, + "rest": { + "libraryClient": "PrivateCatalogClient", + "rpcs": { + "SearchCatalogs": { + "methods": [ + "search_catalogs" + ] + }, + "SearchProducts": { + "methods": [ + "search_products" + ] + }, + "SearchVersions": { + "methods": [ + "search_versions" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_version.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/py.typed b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/py.typed new file mode 100644 index 0000000..dcec715 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-private-catalog package uses inline types. diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/__init__.py new file mode 100644 index 0000000..cb1e6f4 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import PrivateCatalogClient +from .async_client import PrivateCatalogAsyncClient + +__all__ = ( + 'PrivateCatalogClient', + 'PrivateCatalogAsyncClient', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/async_client.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/async_client.py new file mode 100644 index 0000000..c8aff4d --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/async_client.py @@ -0,0 +1,513 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.privatecatalog_v1beta1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.privatecatalog_v1beta1.services.private_catalog import pagers +from google.cloud.privatecatalog_v1beta1.types import private_catalog +from .transports.base import PrivateCatalogTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import PrivateCatalogGrpcAsyncIOTransport +from .client import PrivateCatalogClient + + +class PrivateCatalogAsyncClient: + """``PrivateCatalog`` allows catalog consumers to retrieve ``Catalog``, + ``Product`` and ``Version`` resources under a target resource + context. + + ``Catalog`` is computed based on the [Association][]s linked to the + target resource and its ancestors. Each association's + [google.cloud.privatecatalogproducer.v1beta.Catalog][] is + transformed into a ``Catalog``. If multiple associations have the + same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], + they are de-duplicated into one ``Catalog``. Users must have + ``cloudprivatecatalog.catalogTargets.get`` IAM permission on the + resource context in order to access catalogs. ``Catalog`` contains + the resource name and a subset of data of the original + [google.cloud.privatecatalogproducer.v1beta.Catalog][]. + + ``Product`` is child resource of the catalog. A ``Product`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Product][]. + + ``Version`` is child resource of the product. A ``Version`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Version][]. + """ + + _client: PrivateCatalogClient + + DEFAULT_ENDPOINT = PrivateCatalogClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = PrivateCatalogClient.DEFAULT_MTLS_ENDPOINT + + catalog_path = staticmethod(PrivateCatalogClient.catalog_path) + parse_catalog_path = staticmethod(PrivateCatalogClient.parse_catalog_path) + product_path = staticmethod(PrivateCatalogClient.product_path) + parse_product_path = staticmethod(PrivateCatalogClient.parse_product_path) + version_path = staticmethod(PrivateCatalogClient.version_path) + parse_version_path = staticmethod(PrivateCatalogClient.parse_version_path) + common_billing_account_path = staticmethod(PrivateCatalogClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(PrivateCatalogClient.parse_common_billing_account_path) + common_folder_path = staticmethod(PrivateCatalogClient.common_folder_path) + parse_common_folder_path = staticmethod(PrivateCatalogClient.parse_common_folder_path) + common_organization_path = staticmethod(PrivateCatalogClient.common_organization_path) + parse_common_organization_path = staticmethod(PrivateCatalogClient.parse_common_organization_path) + common_project_path = staticmethod(PrivateCatalogClient.common_project_path) + parse_common_project_path = staticmethod(PrivateCatalogClient.parse_common_project_path) + common_location_path = staticmethod(PrivateCatalogClient.common_location_path) + parse_common_location_path = staticmethod(PrivateCatalogClient.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: + PrivateCatalogAsyncClient: The constructed client. + """ + return PrivateCatalogClient.from_service_account_info.__func__(PrivateCatalogAsyncClient, 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: + PrivateCatalogAsyncClient: The constructed client. + """ + return PrivateCatalogClient.from_service_account_file.__func__(PrivateCatalogAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return PrivateCatalogClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> PrivateCatalogTransport: + """Returns the transport used by the client instance. + + Returns: + PrivateCatalogTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(PrivateCatalogClient).get_transport_class, type(PrivateCatalogClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, PrivateCatalogTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the private catalog client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.PrivateCatalogTransport]): 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 = PrivateCatalogClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def search_catalogs(self, + request: Optional[Union[private_catalog.SearchCatalogsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchCatalogsAsyncPager: + r"""Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + async def sample_search_catalogs(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchCatalogsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_catalogs(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest, dict]]): + The request object. Request message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager: + Response message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + request = private_catalog.SearchCatalogsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_catalogs, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # 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.SearchCatalogsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def search_products(self, + request: Optional[Union[private_catalog.SearchProductsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchProductsAsyncPager: + r"""Search [Product][google.cloud.privatecatalog.v1beta1.Product] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + async def sample_search_products(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchProductsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_products(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest, dict]]): + The request object. Request message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager: + Response message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + request = private_catalog.SearchProductsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_products, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # 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.SearchProductsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def search_versions(self, + request: Optional[Union[private_catalog.SearchVersionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchVersionsAsyncPager: + r"""Search [Version][google.cloud.privatecatalog.v1beta1.Version] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + async def sample_search_versions(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchVersionsRequest( + resource="resource_value", + query="query_value", + ) + + # Make the request + page_result = client.search_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest, dict]]): + The request object. Request message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager: + Response message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + request = private_catalog.SearchVersionsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_versions, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # 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.SearchVersionsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "PrivateCatalogAsyncClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/client.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/client.py new file mode 100644 index 0000000..5fdd0e7 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/client.py @@ -0,0 +1,738 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.privatecatalog_v1beta1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.privatecatalog_v1beta1.services.private_catalog import pagers +from google.cloud.privatecatalog_v1beta1.types import private_catalog +from .transports.base import PrivateCatalogTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import PrivateCatalogGrpcTransport +from .transports.grpc_asyncio import PrivateCatalogGrpcAsyncIOTransport +from .transports.rest import PrivateCatalogRestTransport + + +class PrivateCatalogClientMeta(type): + """Metaclass for the PrivateCatalog 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[PrivateCatalogTransport]] + _transport_registry["grpc"] = PrivateCatalogGrpcTransport + _transport_registry["grpc_asyncio"] = PrivateCatalogGrpcAsyncIOTransport + _transport_registry["rest"] = PrivateCatalogRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[PrivateCatalogTransport]: + """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 PrivateCatalogClient(metaclass=PrivateCatalogClientMeta): + """``PrivateCatalog`` allows catalog consumers to retrieve ``Catalog``, + ``Product`` and ``Version`` resources under a target resource + context. + + ``Catalog`` is computed based on the [Association][]s linked to the + target resource and its ancestors. Each association's + [google.cloud.privatecatalogproducer.v1beta.Catalog][] is + transformed into a ``Catalog``. If multiple associations have the + same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], + they are de-duplicated into one ``Catalog``. Users must have + ``cloudprivatecatalog.catalogTargets.get`` IAM permission on the + resource context in order to access catalogs. ``Catalog`` contains + the resource name and a subset of data of the original + [google.cloud.privatecatalogproducer.v1beta.Catalog][]. + + ``Product`` is child resource of the catalog. A ``Product`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Product][]. + + ``Version`` is child resource of the product. A ``Version`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Version][]. + """ + + @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 = "cloudprivatecatalog.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: + PrivateCatalogClient: 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: + PrivateCatalogClient: 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) -> PrivateCatalogTransport: + """Returns the transport used by the client instance. + + Returns: + PrivateCatalogTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def catalog_path(catalog: str,) -> str: + """Returns a fully-qualified catalog string.""" + return "catalogs/{catalog}".format(catalog=catalog, ) + + @staticmethod + def parse_catalog_path(path: str) -> Dict[str,str]: + """Parses a catalog path into its component segments.""" + m = re.match(r"^catalogs/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def product_path(product: str,) -> str: + """Returns a fully-qualified product string.""" + return "products/{product}".format(product=product, ) + + @staticmethod + def parse_product_path(path: str) -> Dict[str,str]: + """Parses a product path into its component segments.""" + m = re.match(r"^products/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def version_path(catalog: str,product: str,version: str,) -> str: + """Returns a fully-qualified version string.""" + return "catalogs/{catalog}/products/{product}/versions/{version}".format(catalog=catalog, product=product, version=version, ) + + @staticmethod + def parse_version_path(path: str) -> Dict[str,str]: + """Parses a version path into its component segments.""" + m = re.match(r"^catalogs/(?P.+?)/products/(?P.+?)/versions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, PrivateCatalogTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the private catalog client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, PrivateCatalogTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, PrivateCatalogTransport): + # transport is a PrivateCatalogTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def search_catalogs(self, + request: Optional[Union[private_catalog.SearchCatalogsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchCatalogsPager: + r"""Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + def sample_search_catalogs(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchCatalogsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_catalogs(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest, dict]): + The request object. Request message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsPager: + Response message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a private_catalog.SearchCatalogsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, private_catalog.SearchCatalogsRequest): + request = private_catalog.SearchCatalogsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_catalogs] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.SearchCatalogsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def search_products(self, + request: Optional[Union[private_catalog.SearchProductsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchProductsPager: + r"""Search [Product][google.cloud.privatecatalog.v1beta1.Product] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + def sample_search_products(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchProductsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_products(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest, dict]): + The request object. Request message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsPager: + Response message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a private_catalog.SearchProductsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, private_catalog.SearchProductsRequest): + request = private_catalog.SearchProductsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_products] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.SearchProductsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def search_versions(self, + request: Optional[Union[private_catalog.SearchVersionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchVersionsPager: + r"""Search [Version][google.cloud.privatecatalog.v1beta1.Version] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import privatecatalog_v1beta1 + + def sample_search_versions(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchVersionsRequest( + resource="resource_value", + query="query_value", + ) + + # Make the request + page_result = client.search_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest, dict]): + The request object. Request message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + 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.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsPager: + Response message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a private_catalog.SearchVersionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, private_catalog.SearchVersionsRequest): + request = private_catalog.SearchVersionsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_versions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.SearchVersionsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "PrivateCatalogClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "PrivateCatalogClient", +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/pagers.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/pagers.py new file mode 100644 index 0000000..20f4857 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/pagers.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.privatecatalog_v1beta1.types import private_catalog + + +class SearchCatalogsPager: + """A pager for iterating through ``search_catalogs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``catalogs`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchCatalogs`` requests and continue to iterate + through the ``catalogs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse` + 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[..., private_catalog.SearchCatalogsResponse], + request: private_catalog.SearchCatalogsRequest, + response: private_catalog.SearchCatalogsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchCatalogsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse): + 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 = private_catalog.SearchCatalogsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[private_catalog.SearchCatalogsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[private_catalog.Catalog]: + for page in self.pages: + yield from page.catalogs + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchCatalogsAsyncPager: + """A pager for iterating through ``search_catalogs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``catalogs`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchCatalogs`` requests and continue to iterate + through the ``catalogs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse` + 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[private_catalog.SearchCatalogsResponse]], + request: private_catalog.SearchCatalogsRequest, + response: private_catalog.SearchCatalogsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchCatalogsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchCatalogsResponse): + 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 = private_catalog.SearchCatalogsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[private_catalog.SearchCatalogsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[private_catalog.Catalog]: + async def async_generator(): + async for page in self.pages: + for response in page.catalogs: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchProductsPager: + """A pager for iterating through ``search_products`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``products`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchProducts`` requests and continue to iterate + through the ``products`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse` + 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[..., private_catalog.SearchProductsResponse], + request: private_catalog.SearchProductsRequest, + response: private_catalog.SearchProductsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchProductsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse): + 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 = private_catalog.SearchProductsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[private_catalog.SearchProductsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[private_catalog.Product]: + for page in self.pages: + yield from page.products + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchProductsAsyncPager: + """A pager for iterating through ``search_products`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``products`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchProducts`` requests and continue to iterate + through the ``products`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse` + 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[private_catalog.SearchProductsResponse]], + request: private_catalog.SearchProductsRequest, + response: private_catalog.SearchProductsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchProductsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchProductsResponse): + 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 = private_catalog.SearchProductsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[private_catalog.SearchProductsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[private_catalog.Product]: + async def async_generator(): + async for page in self.pages: + for response in page.products: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchVersionsPager: + """A pager for iterating through ``search_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``versions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchVersions`` requests and continue to iterate + through the ``versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse` + 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[..., private_catalog.SearchVersionsResponse], + request: private_catalog.SearchVersionsRequest, + response: private_catalog.SearchVersionsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchVersionsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse): + 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 = private_catalog.SearchVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[private_catalog.SearchVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[private_catalog.Version]: + for page in self.pages: + yield from page.versions + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchVersionsAsyncPager: + """A pager for iterating through ``search_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``versions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchVersions`` requests and continue to iterate + through the ``versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse` + 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[private_catalog.SearchVersionsResponse]], + request: private_catalog.SearchVersionsRequest, + response: private_catalog.SearchVersionsResponse, + *, + 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.privatecatalog_v1beta1.types.SearchVersionsRequest): + The initial request object. + response (google.cloud.privatecatalog_v1beta1.types.SearchVersionsResponse): + 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 = private_catalog.SearchVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[private_catalog.SearchVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[private_catalog.Version]: + async def async_generator(): + async for page in self.pages: + for response in page.versions: + 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/privatecatalog_v1beta1/services/private_catalog/transports/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/__init__.py new file mode 100644 index 0000000..01b8053 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import PrivateCatalogTransport +from .grpc import PrivateCatalogGrpcTransport +from .grpc_asyncio import PrivateCatalogGrpcAsyncIOTransport +from .rest import PrivateCatalogRestTransport +from .rest import PrivateCatalogRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[PrivateCatalogTransport]] +_transport_registry['grpc'] = PrivateCatalogGrpcTransport +_transport_registry['grpc_asyncio'] = PrivateCatalogGrpcAsyncIOTransport +_transport_registry['rest'] = PrivateCatalogRestTransport + +__all__ = ( + 'PrivateCatalogTransport', + 'PrivateCatalogGrpcTransport', + 'PrivateCatalogGrpcAsyncIOTransport', + 'PrivateCatalogRestTransport', + 'PrivateCatalogRestInterceptor', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/base.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/base.py new file mode 100644 index 0000000..35b3a62 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/base.py @@ -0,0 +1,176 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.privatecatalog_v1beta1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.privatecatalog_v1beta1.types import private_catalog + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class PrivateCatalogTransport(abc.ABC): + """Abstract transport class for PrivateCatalog.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'cloudprivatecatalog.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.search_catalogs: gapic_v1.method.wrap_method( + self.search_catalogs, + default_timeout=None, + client_info=client_info, + ), + self.search_products: gapic_v1.method.wrap_method( + self.search_products, + default_timeout=None, + client_info=client_info, + ), + self.search_versions: gapic_v1.method.wrap_method( + self.search_versions, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def search_catalogs(self) -> Callable[ + [private_catalog.SearchCatalogsRequest], + Union[ + private_catalog.SearchCatalogsResponse, + Awaitable[private_catalog.SearchCatalogsResponse] + ]]: + raise NotImplementedError() + + @property + def search_products(self) -> Callable[ + [private_catalog.SearchProductsRequest], + Union[ + private_catalog.SearchProductsResponse, + Awaitable[private_catalog.SearchProductsResponse] + ]]: + raise NotImplementedError() + + @property + def search_versions(self) -> Callable[ + [private_catalog.SearchVersionsRequest], + Union[ + private_catalog.SearchVersionsResponse, + Awaitable[private_catalog.SearchVersionsResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'PrivateCatalogTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc.py new file mode 100644 index 0000000..4438387 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc.py @@ -0,0 +1,343 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.privatecatalog_v1beta1.types import private_catalog +from .base import PrivateCatalogTransport, DEFAULT_CLIENT_INFO + + +class PrivateCatalogGrpcTransport(PrivateCatalogTransport): + """gRPC backend transport for PrivateCatalog. + + ``PrivateCatalog`` allows catalog consumers to retrieve ``Catalog``, + ``Product`` and ``Version`` resources under a target resource + context. + + ``Catalog`` is computed based on the [Association][]s linked to the + target resource and its ancestors. Each association's + [google.cloud.privatecatalogproducer.v1beta.Catalog][] is + transformed into a ``Catalog``. If multiple associations have the + same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], + they are de-duplicated into one ``Catalog``. Users must have + ``cloudprivatecatalog.catalogTargets.get`` IAM permission on the + resource context in order to access catalogs. ``Catalog`` contains + the resource name and a subset of data of the original + [google.cloud.privatecatalogproducer.v1beta.Catalog][]. + + ``Product`` is child resource of the catalog. A ``Product`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Product][]. + + ``Version`` is child resource of the product. A ``Version`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Version][]. + + 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 = 'cloudprivatecatalog.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'cloudprivatecatalog.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def search_catalogs(self) -> Callable[ + [private_catalog.SearchCatalogsRequest], + private_catalog.SearchCatalogsResponse]: + r"""Return a callable for the search catalogs method over gRPC. + + Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchCatalogsRequest], + ~.SearchCatalogsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_catalogs' not in self._stubs: + self._stubs['search_catalogs'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchCatalogs', + request_serializer=private_catalog.SearchCatalogsRequest.serialize, + response_deserializer=private_catalog.SearchCatalogsResponse.deserialize, + ) + return self._stubs['search_catalogs'] + + @property + def search_products(self) -> Callable[ + [private_catalog.SearchProductsRequest], + private_catalog.SearchProductsResponse]: + r"""Return a callable for the search products method over gRPC. + + Search [Product][google.cloud.privatecatalog.v1beta1.Product] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchProductsRequest], + ~.SearchProductsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_products' not in self._stubs: + self._stubs['search_products'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchProducts', + request_serializer=private_catalog.SearchProductsRequest.serialize, + response_deserializer=private_catalog.SearchProductsResponse.deserialize, + ) + return self._stubs['search_products'] + + @property + def search_versions(self) -> Callable[ + [private_catalog.SearchVersionsRequest], + private_catalog.SearchVersionsResponse]: + r"""Return a callable for the search versions method over gRPC. + + Search [Version][google.cloud.privatecatalog.v1beta1.Version] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchVersionsRequest], + ~.SearchVersionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_versions' not in self._stubs: + self._stubs['search_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchVersions', + request_serializer=private_catalog.SearchVersionsRequest.serialize, + response_deserializer=private_catalog.SearchVersionsResponse.deserialize, + ) + return self._stubs['search_versions'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'PrivateCatalogGrpcTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc_asyncio.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc_asyncio.py new file mode 100644 index 0000000..f8d2158 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/grpc_asyncio.py @@ -0,0 +1,342 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.privatecatalog_v1beta1.types import private_catalog +from .base import PrivateCatalogTransport, DEFAULT_CLIENT_INFO +from .grpc import PrivateCatalogGrpcTransport + + +class PrivateCatalogGrpcAsyncIOTransport(PrivateCatalogTransport): + """gRPC AsyncIO backend transport for PrivateCatalog. + + ``PrivateCatalog`` allows catalog consumers to retrieve ``Catalog``, + ``Product`` and ``Version`` resources under a target resource + context. + + ``Catalog`` is computed based on the [Association][]s linked to the + target resource and its ancestors. Each association's + [google.cloud.privatecatalogproducer.v1beta.Catalog][] is + transformed into a ``Catalog``. If multiple associations have the + same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], + they are de-duplicated into one ``Catalog``. Users must have + ``cloudprivatecatalog.catalogTargets.get`` IAM permission on the + resource context in order to access catalogs. ``Catalog`` contains + the resource name and a subset of data of the original + [google.cloud.privatecatalogproducer.v1beta.Catalog][]. + + ``Product`` is child resource of the catalog. A ``Product`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Product][]. + + ``Version`` is child resource of the product. A ``Version`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Version][]. + + 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 = 'cloudprivatecatalog.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'cloudprivatecatalog.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def search_catalogs(self) -> Callable[ + [private_catalog.SearchCatalogsRequest], + Awaitable[private_catalog.SearchCatalogsResponse]]: + r"""Return a callable for the search catalogs method over gRPC. + + Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchCatalogsRequest], + Awaitable[~.SearchCatalogsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_catalogs' not in self._stubs: + self._stubs['search_catalogs'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchCatalogs', + request_serializer=private_catalog.SearchCatalogsRequest.serialize, + response_deserializer=private_catalog.SearchCatalogsResponse.deserialize, + ) + return self._stubs['search_catalogs'] + + @property + def search_products(self) -> Callable[ + [private_catalog.SearchProductsRequest], + Awaitable[private_catalog.SearchProductsResponse]]: + r"""Return a callable for the search products method over gRPC. + + Search [Product][google.cloud.privatecatalog.v1beta1.Product] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchProductsRequest], + Awaitable[~.SearchProductsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_products' not in self._stubs: + self._stubs['search_products'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchProducts', + request_serializer=private_catalog.SearchProductsRequest.serialize, + response_deserializer=private_catalog.SearchProductsResponse.deserialize, + ) + return self._stubs['search_products'] + + @property + def search_versions(self) -> Callable[ + [private_catalog.SearchVersionsRequest], + Awaitable[private_catalog.SearchVersionsResponse]]: + r"""Return a callable for the search versions method over gRPC. + + Search [Version][google.cloud.privatecatalog.v1beta1.Version] + resources that consumers have access to, within the scope of the + consumer cloud resource hierarchy context. + + Returns: + Callable[[~.SearchVersionsRequest], + Awaitable[~.SearchVersionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_versions' not in self._stubs: + self._stubs['search_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.privatecatalog.v1beta1.PrivateCatalog/SearchVersions', + request_serializer=private_catalog.SearchVersionsRequest.serialize, + response_deserializer=private_catalog.SearchVersionsResponse.deserialize, + ) + return self._stubs['search_versions'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'PrivateCatalogGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/rest.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/rest.py new file mode 100644 index 0000000..e744671 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/services/private_catalog/transports/rest.py @@ -0,0 +1,562 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.privatecatalog_v1beta1.types import private_catalog + +from .base import PrivateCatalogTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class PrivateCatalogRestInterceptor: + """Interceptor for PrivateCatalog. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the PrivateCatalogRestTransport. + + .. code-block:: python + class MyCustomPrivateCatalogInterceptor(PrivateCatalogRestInterceptor): + def pre_search_catalogs(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_catalogs(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_products(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_products(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_versions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_versions(self, response): + logging.log(f"Received response: {response}") + return response + + transport = PrivateCatalogRestTransport(interceptor=MyCustomPrivateCatalogInterceptor()) + client = PrivateCatalogClient(transport=transport) + + + """ + def pre_search_catalogs(self, request: private_catalog.SearchCatalogsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[private_catalog.SearchCatalogsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_catalogs + + Override in a subclass to manipulate the request or metadata + before they are sent to the PrivateCatalog server. + """ + return request, metadata + + def post_search_catalogs(self, response: private_catalog.SearchCatalogsResponse) -> private_catalog.SearchCatalogsResponse: + """Post-rpc interceptor for search_catalogs + + Override in a subclass to manipulate the response + after it is returned by the PrivateCatalog server but before + it is returned to user code. + """ + return response + def pre_search_products(self, request: private_catalog.SearchProductsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[private_catalog.SearchProductsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_products + + Override in a subclass to manipulate the request or metadata + before they are sent to the PrivateCatalog server. + """ + return request, metadata + + def post_search_products(self, response: private_catalog.SearchProductsResponse) -> private_catalog.SearchProductsResponse: + """Post-rpc interceptor for search_products + + Override in a subclass to manipulate the response + after it is returned by the PrivateCatalog server but before + it is returned to user code. + """ + return response + def pre_search_versions(self, request: private_catalog.SearchVersionsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[private_catalog.SearchVersionsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_versions + + Override in a subclass to manipulate the request or metadata + before they are sent to the PrivateCatalog server. + """ + return request, metadata + + def post_search_versions(self, response: private_catalog.SearchVersionsResponse) -> private_catalog.SearchVersionsResponse: + """Post-rpc interceptor for search_versions + + Override in a subclass to manipulate the response + after it is returned by the PrivateCatalog server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class PrivateCatalogRestStub: + _session: AuthorizedSession + _host: str + _interceptor: PrivateCatalogRestInterceptor + + +class PrivateCatalogRestTransport(PrivateCatalogTransport): + """REST backend transport for PrivateCatalog. + + ``PrivateCatalog`` allows catalog consumers to retrieve ``Catalog``, + ``Product`` and ``Version`` resources under a target resource + context. + + ``Catalog`` is computed based on the [Association][]s linked to the + target resource and its ancestors. Each association's + [google.cloud.privatecatalogproducer.v1beta.Catalog][] is + transformed into a ``Catalog``. If multiple associations have the + same parent [google.cloud.privatecatalogproducer.v1beta.Catalog][], + they are de-duplicated into one ``Catalog``. Users must have + ``cloudprivatecatalog.catalogTargets.get`` IAM permission on the + resource context in order to access catalogs. ``Catalog`` contains + the resource name and a subset of data of the original + [google.cloud.privatecatalogproducer.v1beta.Catalog][]. + + ``Product`` is child resource of the catalog. A ``Product`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Product][]. + + ``Version`` is child resource of the product. A ``Version`` contains + the resource name and a subset of the data of the original + [google.cloud.privatecatalogproducer.v1beta.Version][]. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'cloudprivatecatalog.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[PrivateCatalogRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or PrivateCatalogRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _SearchCatalogs(PrivateCatalogRestStub): + def __hash__(self): + return hash("SearchCatalogs") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: private_catalog.SearchCatalogsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> private_catalog.SearchCatalogsResponse: + r"""Call the search catalogs method over HTTP. + + Args: + request (~.private_catalog.SearchCatalogsRequest): + The request object. Request message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.private_catalog.SearchCatalogsResponse: + Response message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{resource=projects/*}/catalogs:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=organizations/*}/catalogs:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=folders/*}/catalogs:search', + }, + ] + request, metadata = self._interceptor.pre_search_catalogs(request, metadata) + pb_request = private_catalog.SearchCatalogsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = private_catalog.SearchCatalogsResponse() + pb_resp = private_catalog.SearchCatalogsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_catalogs(resp) + return resp + + class _SearchProducts(PrivateCatalogRestStub): + def __hash__(self): + return hash("SearchProducts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: private_catalog.SearchProductsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> private_catalog.SearchProductsResponse: + r"""Call the search products method over HTTP. + + Args: + request (~.private_catalog.SearchProductsRequest): + The request object. Request message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.private_catalog.SearchProductsResponse: + Response message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{resource=projects/*}/products:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=organizations/*}/products:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=folders/*}/products:search', + }, + ] + request, metadata = self._interceptor.pre_search_products(request, metadata) + pb_request = private_catalog.SearchProductsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = private_catalog.SearchProductsResponse() + pb_resp = private_catalog.SearchProductsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_products(resp) + return resp + + class _SearchVersions(PrivateCatalogRestStub): + def __hash__(self): + return hash("SearchVersions") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "query" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: private_catalog.SearchVersionsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> private_catalog.SearchVersionsResponse: + r"""Call the search versions method over HTTP. + + Args: + request (~.private_catalog.SearchVersionsRequest): + The request object. Request message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.private_catalog.SearchVersionsResponse: + Response message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1beta1/{resource=projects/*}/versions:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=organizations/*}/versions:search', + }, +{ + 'method': 'get', + 'uri': '/v1beta1/{resource=folders/*}/versions:search', + }, + ] + request, metadata = self._interceptor.pre_search_versions(request, metadata) + pb_request = private_catalog.SearchVersionsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = private_catalog.SearchVersionsResponse() + pb_resp = private_catalog.SearchVersionsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_versions(resp) + return resp + + @property + def search_catalogs(self) -> Callable[ + [private_catalog.SearchCatalogsRequest], + private_catalog.SearchCatalogsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SearchCatalogs(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_products(self) -> Callable[ + [private_catalog.SearchProductsRequest], + private_catalog.SearchProductsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SearchProducts(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_versions(self) -> Callable[ + [private_catalog.SearchVersionsRequest], + private_catalog.SearchVersionsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SearchVersions(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'PrivateCatalogRestTransport', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/__init__.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/__init__.py new file mode 100644 index 0000000..48e94ed --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/__init__.py @@ -0,0 +1,46 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .private_catalog import ( + AssetReference, + Catalog, + GcsSource, + GitSource, + Inputs, + Product, + SearchCatalogsRequest, + SearchCatalogsResponse, + SearchProductsRequest, + SearchProductsResponse, + SearchVersionsRequest, + SearchVersionsResponse, + Version, +) + +__all__ = ( + 'AssetReference', + 'Catalog', + 'GcsSource', + 'GitSource', + 'Inputs', + 'Product', + 'SearchCatalogsRequest', + 'SearchCatalogsResponse', + 'SearchProductsRequest', + 'SearchProductsResponse', + 'SearchVersionsRequest', + 'SearchVersionsResponse', + 'Version', +) diff --git a/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/private_catalog.py b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/private_catalog.py new file mode 100644 index 0000000..1d677b1 --- /dev/null +++ b/owl-bot-staging/v1beta1/google/cloud/privatecatalog_v1beta1/types/private_catalog.py @@ -0,0 +1,824 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.longrunning import operations_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.privatecatalog.v1beta1', + manifest={ + 'SearchCatalogsRequest', + 'SearchCatalogsResponse', + 'SearchProductsRequest', + 'SearchProductsResponse', + 'SearchVersionsRequest', + 'SearchVersionsResponse', + 'Catalog', + 'Product', + 'AssetReference', + 'Inputs', + 'GcsSource', + 'GitSource', + 'Version', + }, +) + + +class SearchCatalogsRequest(proto.Message): + r"""Request message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + + Attributes: + resource (str): + Required. The name of the resource context. It can be in + following formats: + + - ``projects/{project}`` + - ``folders/{folder}`` + - ``organizations/{organization}`` + query (str): + The query to filter the catalogs. The supported queries are: + + - Get a single catalog: ``name=catalogs/{catalog}`` + page_size (int): + The maximum number of entries that are + requested. + page_token (str): + A pagination token returned from a previous + call to SearchCatalogs that indicates where this + listing should continue from. + """ + + resource: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchCatalogsResponse(proto.Message): + r"""Response message for + [PrivateCatalog.SearchCatalogs][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs]. + + Attributes: + catalogs (MutableSequence[google.cloud.privatecatalog_v1beta1.types.Catalog]): + The ``Catalog``\ s computed from the resource context. + next_page_token (str): + A pagination token returned from a previous + call to SearchCatalogs that indicates from where + listing should continue. + """ + + @property + def raw_page(self): + return self + + catalogs: MutableSequence['Catalog'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Catalog', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchProductsRequest(proto.Message): + r"""Request message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + + Attributes: + resource (str): + Required. The name of the resource context. See + [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource] + for details. + query (str): + The query to filter the products. + + The supported queries are: + + - List products of all catalogs: empty + - List products under a catalog: + ``parent=catalogs/{catalog}`` + - Get a product by name: + ``name=catalogs/{catalog}/products/{product}`` + page_size (int): + The maximum number of entries that are + requested. + page_token (str): + A pagination token returned from a previous + call to SearchProducts that indicates where this + listing should continue from. + """ + + resource: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchProductsResponse(proto.Message): + r"""Response message for + [PrivateCatalog.SearchProducts][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts]. + + Attributes: + products (MutableSequence[google.cloud.privatecatalog_v1beta1.types.Product]): + The ``Product`` resources computed from the resource + context. + next_page_token (str): + A pagination token returned from a previous + call to SearchProducts that indicates from where + listing should continue. + """ + + @property + def raw_page(self): + return self + + products: MutableSequence['Product'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Product', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchVersionsRequest(proto.Message): + r"""Request message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + + Attributes: + resource (str): + Required. The name of the resource context. See + [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource] + for details. + query (str): + Required. The query to filter the versions. + + The supported queries are: + + - List versions under a product: + ``parent=catalogs/{catalog}/products/{product}`` + - Get a version by name: + ``name=catalogs/{catalog}/products/{product}/versions/{version}`` + page_size (int): + The maximum number of entries that are + requested. + page_token (str): + A pagination token returned from a previous + call to SearchVersions that indicates where this + listing should continue from. + """ + + resource: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchVersionsResponse(proto.Message): + r"""Response message for + [PrivateCatalog.SearchVersions][google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions]. + + Attributes: + versions (MutableSequence[google.cloud.privatecatalog_v1beta1.types.Version]): + The ``Version`` resources computed from the resource + context. + next_page_token (str): + A pagination token returned from a previous + call to SearchVersions that indicates from where + the listing should continue. + """ + + @property + def raw_page(self): + return self + + versions: MutableSequence['Version'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Version', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class Catalog(proto.Message): + r"""The readonly representation of a catalog computed with a + given resource context. + + Attributes: + name (str): + Output only. The resource name of the target catalog, in the + format of \`catalogs/{catalog}'. + display_name (str): + Output only. The descriptive name of the + catalog as it appears in UIs. + description (str): + Output only. The description of the catalog. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the catalog was + created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the catalog was + last updated. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + display_name: str = proto.Field( + proto.STRING, + number=2, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + + +class Product(proto.Message): + r"""The readonly representation of a product computed with a + given resource context. + + Attributes: + name (str): + Output only. The resource name of the target product, in the + format of \`products/[a-z][-a-z0-9]*[a-z0-9]'. + + A unique identifier for the product under a catalog. + asset_type (str): + Output only. The type of the product asset. It can be one of + the following values: + + - ``google.deploymentmanager.Template`` + - ``google.cloudprivatecatalog.ListingOnly`` + - ``google.cloudprivatecatalog.Terraform`` + display_metadata (google.protobuf.struct_pb2.Struct): + Required. Output only. The display metadata to describe the + product. The JSON schema of the metadata differs by + [Product.asset_type][google.cloud.privatecatalog.v1beta1.Product.asset_type]. + When the type is ``google.deploymentmanager.Template``, the + schema is as follows: + + :: + + "$schema": http://json-schema.org/draft-04/schema# + type: object + properties: + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + tagline: + type: string + minLength: 1 + maxLength: 100 + support_info: + type: string + minLength: 1 + maxLength: 2048 + creator: + type: string + minLength: 1 + maxLength: 100 + documentations: + type: array + items: + type: object + properties: + url: + type: string + pattern: + "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" + title: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + required: + - name + - description + additionalProperties: false + + When the asset type is + ``google.cloudprivatecatalog.ListingOnly``, the schema is as + follows: + + :: + + "$schema": http://json-schema.org/draft-04/schema# + type: object + properties: + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + tagline: + type: string + minLength: 1 + maxLength: 100 + support_info: + type: string + minLength: 1 + maxLength: 2048 + creator: + type: string + minLength: 1 + maxLength: 100 + documentations: + type: array + items: + type: object + properties: + url: + type: string + pattern: + "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" + title: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + signup_url: + type: string + pattern: + "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" + required: + - name + - description + - signup_url + additionalProperties: false + + When the asset type is + ``google.cloudprivatecatalog.Terraform``, the schema is as + follows: + + :: + + "$schema": http://json-schema.org/draft-04/schema# + type: object + properties: + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + tagline: + type: string + minLength: 1 + maxLength: 100 + support_info: + type: string + minLength: 1 + maxLength: 2048 + creator: + type: string + minLength: 1 + maxLength: 100 + documentations: + type: array + items: + type: object + properties: + url: + type: string + pattern: + "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" + title: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + minLength: 1 + maxLength: 2048 + required: + - name + - description + additionalProperties: true + icon_uri (str): + Output only. The icon URI of the product. + asset_references (MutableSequence[google.cloud.privatecatalog_v1beta1.types.AssetReference]): + Output only. A collection of assets referred + by a product. This field is set for Terraform + Products only. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the product was + created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the product was + last updated. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + asset_type: str = proto.Field( + proto.STRING, + number=2, + ) + display_metadata: struct_pb2.Struct = proto.Field( + proto.MESSAGE, + number=3, + message=struct_pb2.Struct, + ) + icon_uri: str = proto.Field( + proto.STRING, + number=4, + ) + asset_references: MutableSequence['AssetReference'] = proto.RepeatedField( + proto.MESSAGE, + number=10, + message='AssetReference', + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + + +class AssetReference(proto.Message): + r"""Defines the reference of an asset belonging to a product. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + id (str): + Output only. A unique identifier among asset + references in a product. + description (str): + Output only. The human-readable description + of the referenced asset. Maximum 256 characters + in length. + inputs (google.cloud.privatecatalog_v1beta1.types.Inputs): + Output only. The definition of input + parameters to hydrate the asset template. + validation_status (google.cloud.privatecatalog_v1beta1.types.AssetReference.AssetValidationState): + Output only. The current state of the asset + reference. + validation_operation (google.longrunning.operations_pb2.Operation): + Output only. The validation process metadata. + asset (str): + Output only. The asset resource name if an + asset is hosted by Private Catalog. + + This field is a member of `oneof`_ ``source``. + gcs_path (str): + Output only. The cloud storage object path. + + This field is a member of `oneof`_ ``source``. + git_source (google.cloud.privatecatalog_v1beta1.types.GitSource): + Output only. The git source. + + This field is a member of `oneof`_ ``source``. + gcs_source (google.cloud.privatecatalog_v1beta1.types.GcsSource): + Output only. The cloud storage source. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The creation timestamp of the + asset reference. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The last update timestamp of the + asset reference. + version (str): + The version of the source used for this asset + reference. + """ + class AssetValidationState(proto.Enum): + r"""Possible validation steates of an asset reference. + + Values: + ASSET_VALIDATION_STATE_UNSPECIFIED (0): + Unknown state. + PENDING (1): + The validation is still in process. + VALID (2): + The validation is done and the asset + reference is valid. + INVALID (3): + The validation is done and the asset + reference is invalid. + """ + ASSET_VALIDATION_STATE_UNSPECIFIED = 0 + PENDING = 1 + VALID = 2 + INVALID = 3 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + description: str = proto.Field( + proto.STRING, + number=2, + ) + inputs: 'Inputs' = proto.Field( + proto.MESSAGE, + number=6, + message='Inputs', + ) + validation_status: AssetValidationState = proto.Field( + proto.ENUM, + number=7, + enum=AssetValidationState, + ) + validation_operation: operations_pb2.Operation = proto.Field( + proto.MESSAGE, + number=8, + message=operations_pb2.Operation, + ) + asset: str = proto.Field( + proto.STRING, + number=10, + oneof='source', + ) + gcs_path: str = proto.Field( + proto.STRING, + number=11, + oneof='source', + ) + git_source: 'GitSource' = proto.Field( + proto.MESSAGE, + number=15, + oneof='source', + message='GitSource', + ) + gcs_source: 'GcsSource' = proto.Field( + proto.MESSAGE, + number=16, + message='GcsSource', + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=13, + message=timestamp_pb2.Timestamp, + ) + version: str = proto.Field( + proto.STRING, + number=14, + ) + + +class Inputs(proto.Message): + r"""Defines definition of input parameters of asset templates. + + Attributes: + parameters (google.protobuf.struct_pb2.Struct): + Output only. The JSON schema defining the + inputs and their formats. + """ + + parameters: struct_pb2.Struct = proto.Field( + proto.MESSAGE, + number=1, + message=struct_pb2.Struct, + ) + + +class GcsSource(proto.Message): + r"""Defines how to access Cloud Storage source. + + Attributes: + gcs_path (str): + Output only. the cloud storage object path. + generation (int): + Output only. Generation of the object, which + is set when the content of an object starts + being written. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the object + metadata was last changed. + """ + + gcs_path: str = proto.Field( + proto.STRING, + number=1, + ) + generation: int = proto.Field( + proto.INT64, + number=2, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + + +class GitSource(proto.Message): + r"""Defines how to access a Git Source. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + repo (str): + Location of the Git repo to build. + dir_ (str): + Directory, relative to the source root, in which to run the + build. + + This must be a relative path. If a step's ``dir`` is + specified and is an absolute path, this value is ignored for + that step's execution. + commit (str): + The revision commit to use. + + This field is a member of `oneof`_ ``ref``. + branch (str): + The revision branch to use. + + This field is a member of `oneof`_ ``ref``. + tag (str): + The revision tag to use. + + This field is a member of `oneof`_ ``ref``. + """ + + repo: str = proto.Field( + proto.STRING, + number=1, + ) + dir_: str = proto.Field( + proto.STRING, + number=2, + ) + commit: str = proto.Field( + proto.STRING, + number=3, + oneof='ref', + ) + branch: str = proto.Field( + proto.STRING, + number=4, + oneof='ref', + ) + tag: str = proto.Field( + proto.STRING, + number=5, + oneof='ref', + ) + + +class Version(proto.Message): + r"""The consumer representation of a version which is a child resource + under a ``Product`` with asset data. + + Attributes: + name (str): + Output only. The resource name of the version, in the format + \`catalogs/{catalog}/products/{product}/versions/[a-z][-a-z0-9]*[a-z0-9]'. + + A unique identifier for the version under a product. + description (str): + Output only. The user-supplied description of + the version. Maximum of 256 characters. + asset (google.protobuf.struct_pb2.Struct): + Output only. The asset which has been validated and is ready + to be provisioned. See + [google.cloud.privatecatalogproducer.v1beta.Version.asset][] + for details. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the version was + created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the version was + last updated. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + description: str = proto.Field( + proto.STRING, + number=2, + ) + asset: struct_pb2.Struct = proto.Field( + proto.MESSAGE, + number=3, + message=struct_pb2.Struct, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1beta1/mypy.ini b/owl-bot-staging/v1beta1/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v1beta1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1beta1/noxfile.py b/owl-bot-staging/v1beta1/noxfile.py new file mode 100644 index 0000000..d3a38c1 --- /dev/null +++ b/owl-bot-staging/v1beta1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/privatecatalog_v1beta1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py new file mode 100644 index 0000000..514b200 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchCatalogs +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +async def sample_search_catalogs(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchCatalogsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_catalogs(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py new file mode 100644 index 0000000..52a85a1 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchCatalogs +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +def sample_search_catalogs(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchCatalogsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_catalogs(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py new file mode 100644 index 0000000..7add759 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchProducts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +async def sample_search_products(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchProductsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_products(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py new file mode 100644 index 0000000..b62294d --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchProducts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +def sample_search_products(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchProductsRequest( + resource="resource_value", + ) + + # Make the request + page_result = client.search_products(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py new file mode 100644 index 0000000..a7a8037 --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +async def sample_search_versions(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogAsyncClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchVersionsRequest( + resource="resource_value", + query="query_value", + ) + + # Make the request + page_result = client.search_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_async] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py new file mode 100644 index 0000000..5a3215d --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SearchVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-private-catalog + + +# [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import privatecatalog_v1beta1 + + +def sample_search_versions(): + # Create a client + client = privatecatalog_v1beta1.PrivateCatalogClient() + + # Initialize request argument(s) + request = privatecatalog_v1beta1.SearchVersionsRequest( + resource="resource_value", + query="query_value", + ) + + # Make the request + page_result = client.search_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_sync] diff --git a/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.privatecatalog.v1beta1.json b/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.privatecatalog.v1beta1.json new file mode 100644 index 0000000..cc341df --- /dev/null +++ b/owl-bot-staging/v1beta1/samples/generated_samples/snippet_metadata_google.cloud.privatecatalog.v1beta1.json @@ -0,0 +1,474 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.privatecatalog.v1beta1", + "version": "v1beta1" + } + ], + "language": "PYTHON", + "name": "google-cloud-private-catalog", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient", + "shortName": "PrivateCatalogAsyncClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient.search_catalogs", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchCatalogs" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsAsyncPager", + "shortName": "search_catalogs" + }, + "description": "Sample for SearchCatalogs", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient", + "shortName": "PrivateCatalogClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient.search_catalogs", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchCatalogs", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchCatalogs" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchCatalogsPager", + "shortName": "search_catalogs" + }, + "description": "Sample for SearchCatalogs", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchCatalogs_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_catalogs_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient", + "shortName": "PrivateCatalogAsyncClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient.search_products", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchProducts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsAsyncPager", + "shortName": "search_products" + }, + "description": "Sample for SearchProducts", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient", + "shortName": "PrivateCatalogClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient.search_products", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchProducts", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchProducts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchProductsPager", + "shortName": "search_products" + }, + "description": "Sample for SearchProducts", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_products_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient", + "shortName": "PrivateCatalogAsyncClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogAsyncClient.search_versions", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsAsyncPager", + "shortName": "search_versions" + }, + "description": "Sample for SearchVersions", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient", + "shortName": "PrivateCatalogClient" + }, + "fullName": "google.cloud.privatecatalog_v1beta1.PrivateCatalogClient.search_versions", + "method": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog.SearchVersions", + "service": { + "fullName": "google.cloud.privatecatalog.v1beta1.PrivateCatalog", + "shortName": "PrivateCatalog" + }, + "shortName": "SearchVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.privatecatalog_v1beta1.services.private_catalog.pagers.SearchVersionsPager", + "shortName": "search_versions" + }, + "description": "Sample for SearchVersions", + "file": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudprivatecatalog_v1beta1_generated_private_catalog_search_versions_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1beta1/scripts/fixup_privatecatalog_v1beta1_keywords.py b/owl-bot-staging/v1beta1/scripts/fixup_privatecatalog_v1beta1_keywords.py new file mode 100644 index 0000000..61ebb8a --- /dev/null +++ b/owl-bot-staging/v1beta1/scripts/fixup_privatecatalog_v1beta1_keywords.py @@ -0,0 +1,178 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class privatecatalogCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'search_catalogs': ('resource', 'query', 'page_size', 'page_token', ), + 'search_products': ('resource', 'query', 'page_size', 'page_token', ), + 'search_versions': ('resource', 'query', 'page_size', 'page_token', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=privatecatalogCallTransformer(), +): + """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 privatecatalog 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..09e33f7 --- /dev/null +++ b/owl-bot-staging/v1beta1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-private-catalog' + + +description = "Google Cloud Private Catalog API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/privatecatalog/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-private-catalog" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.10.txt b/owl-bot-staging/v1beta1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.11.txt b/owl-bot-staging/v1beta1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.12.txt b/owl-bot-staging/v1beta1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.7.txt b/owl-bot-staging/v1beta1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.8.txt b/owl-bot-staging/v1beta1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/testing/constraints-3.9.txt b/owl-bot-staging/v1beta1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1beta1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1beta1/tests/__init__.py b/owl-bot-staging/v1beta1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/__init__.py b/owl-bot-staging/v1beta1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/__init__.py b/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/test_private_catalog.py b/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/test_private_catalog.py new file mode 100644 index 0000000..61b6b80 --- /dev/null +++ b/owl-bot-staging/v1beta1/tests/unit/gapic/privatecatalog_v1beta1/test_private_catalog.py @@ -0,0 +1,3000 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.privatecatalog_v1beta1.services.private_catalog import PrivateCatalogAsyncClient +from google.cloud.privatecatalog_v1beta1.services.private_catalog import PrivateCatalogClient +from google.cloud.privatecatalog_v1beta1.services.private_catalog import pagers +from google.cloud.privatecatalog_v1beta1.services.private_catalog import transports +from google.cloud.privatecatalog_v1beta1.types import private_catalog +from google.oauth2 import service_account +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert PrivateCatalogClient._get_default_mtls_endpoint(None) is None + assert PrivateCatalogClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert PrivateCatalogClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert PrivateCatalogClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert PrivateCatalogClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert PrivateCatalogClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (PrivateCatalogClient, "grpc"), + (PrivateCatalogAsyncClient, "grpc_asyncio"), + (PrivateCatalogClient, "rest"), +]) +def test_private_catalog_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'cloudprivatecatalog.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudprivatecatalog.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.PrivateCatalogGrpcTransport, "grpc"), + (transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.PrivateCatalogRestTransport, "rest"), +]) +def test_private_catalog_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (PrivateCatalogClient, "grpc"), + (PrivateCatalogAsyncClient, "grpc_asyncio"), + (PrivateCatalogClient, "rest"), +]) +def test_private_catalog_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'cloudprivatecatalog.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://cloudprivatecatalog.googleapis.com' + ) + + +def test_private_catalog_client_get_transport_class(): + transport = PrivateCatalogClient.get_transport_class() + available_transports = [ + transports.PrivateCatalogGrpcTransport, + transports.PrivateCatalogRestTransport, + ] + assert transport in available_transports + + transport = PrivateCatalogClient.get_transport_class("grpc") + assert transport == transports.PrivateCatalogGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc"), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (PrivateCatalogClient, transports.PrivateCatalogRestTransport, "rest"), +]) +@mock.patch.object(PrivateCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogClient)) +@mock.patch.object(PrivateCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogAsyncClient)) +def test_private_catalog_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(PrivateCatalogClient, '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(PrivateCatalogClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc", "true"), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc", "false"), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (PrivateCatalogClient, transports.PrivateCatalogRestTransport, "rest", "true"), + (PrivateCatalogClient, transports.PrivateCatalogRestTransport, "rest", "false"), +]) +@mock.patch.object(PrivateCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogClient)) +@mock.patch.object(PrivateCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_private_catalog_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + PrivateCatalogClient, PrivateCatalogAsyncClient +]) +@mock.patch.object(PrivateCatalogClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogClient)) +@mock.patch.object(PrivateCatalogAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(PrivateCatalogAsyncClient)) +def test_private_catalog_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc"), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio"), + (PrivateCatalogClient, transports.PrivateCatalogRestTransport, "rest"), +]) +def test_private_catalog_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc", grpc_helpers), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (PrivateCatalogClient, transports.PrivateCatalogRestTransport, "rest", None), +]) +def test_private_catalog_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_private_catalog_client_client_options_from_dict(): + with mock.patch('google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.PrivateCatalogGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = PrivateCatalogClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport, "grpc", grpc_helpers), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_private_catalog_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "cloudprivatecatalog.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="cloudprivatecatalog.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchCatalogsRequest, + dict, +]) +def test_search_catalogs(request_type, transport: str = 'grpc'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = private_catalog.SearchCatalogsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_catalogs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchCatalogsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchCatalogsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_catalogs_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 = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + client.search_catalogs() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchCatalogsRequest() + +@pytest.mark.asyncio +async def test_search_catalogs_async(transport: str = 'grpc_asyncio', request_type=private_catalog.SearchCatalogsRequest): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchCatalogsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_catalogs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchCatalogsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchCatalogsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_catalogs_async_from_dict(): + await test_search_catalogs_async(request_type=dict) + + +def test_search_catalogs_field_headers(): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchCatalogsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + call.return_value = private_catalog.SearchCatalogsResponse() + client.search_catalogs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_catalogs_field_headers_async(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchCatalogsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchCatalogsResponse()) + await client.search_catalogs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +def test_search_catalogs_pager(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + next_page_token='abc', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[], + next_page_token='def', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + ], + next_page_token='ghi', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('resource', ''), + )), + ) + pager = client.search_catalogs(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Catalog) + for i in results) +def test_search_catalogs_pages(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + next_page_token='abc', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[], + next_page_token='def', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + ], + next_page_token='ghi', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + ), + RuntimeError, + ) + pages = list(client.search_catalogs(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_catalogs_async_pager(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + next_page_token='abc', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[], + next_page_token='def', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + ], + next_page_token='ghi', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_catalogs(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, private_catalog.Catalog) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_catalogs_async_pages(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_catalogs), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + next_page_token='abc', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[], + next_page_token='def', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + ], + next_page_token='ghi', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_catalogs(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchProductsRequest, + dict, +]) +def test_search_products(request_type, transport: str = 'grpc'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = private_catalog.SearchProductsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_products(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchProductsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchProductsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_products_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 = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + client.search_products() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchProductsRequest() + +@pytest.mark.asyncio +async def test_search_products_async(transport: str = 'grpc_asyncio', request_type=private_catalog.SearchProductsRequest): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchProductsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_products(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchProductsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchProductsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_products_async_from_dict(): + await test_search_products_async(request_type=dict) + + +def test_search_products_field_headers(): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchProductsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + call.return_value = private_catalog.SearchProductsResponse() + client.search_products(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_products_field_headers_async(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchProductsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchProductsResponse()) + await client.search_products(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +def test_search_products_pager(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + private_catalog.Product(), + ], + next_page_token='abc', + ), + private_catalog.SearchProductsResponse( + products=[], + next_page_token='def', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + ], + next_page_token='ghi', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('resource', ''), + )), + ) + pager = client.search_products(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Product) + for i in results) +def test_search_products_pages(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + private_catalog.Product(), + ], + next_page_token='abc', + ), + private_catalog.SearchProductsResponse( + products=[], + next_page_token='def', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + ], + next_page_token='ghi', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + ], + ), + RuntimeError, + ) + pages = list(client.search_products(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_products_async_pager(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + private_catalog.Product(), + ], + next_page_token='abc', + ), + private_catalog.SearchProductsResponse( + products=[], + next_page_token='def', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + ], + next_page_token='ghi', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_products(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, private_catalog.Product) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_products_async_pages(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_products), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + private_catalog.Product(), + ], + next_page_token='abc', + ), + private_catalog.SearchProductsResponse( + products=[], + next_page_token='def', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + ], + next_page_token='ghi', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_products(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchVersionsRequest, + dict, +]) +def test_search_versions(request_type, transport: str = 'grpc'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = private_catalog.SearchVersionsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchVersionsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_versions_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 = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + client.search_versions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchVersionsRequest() + +@pytest.mark.asyncio +async def test_search_versions_async(transport: str = 'grpc_asyncio', request_type=private_catalog.SearchVersionsRequest): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchVersionsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == private_catalog.SearchVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchVersionsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_versions_async_from_dict(): + await test_search_versions_async(request_type=dict) + + +def test_search_versions_field_headers(): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchVersionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + call.return_value = private_catalog.SearchVersionsResponse() + client.search_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_versions_field_headers_async(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = private_catalog.SearchVersionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(private_catalog.SearchVersionsResponse()) + await client.search_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +def test_search_versions_pager(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + private_catalog.Version(), + ], + next_page_token='abc', + ), + private_catalog.SearchVersionsResponse( + versions=[], + next_page_token='def', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + ], + next_page_token='ghi', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('resource', ''), + )), + ) + pager = client.search_versions(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Version) + for i in results) +def test_search_versions_pages(transport_name: str = "grpc"): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + private_catalog.Version(), + ], + next_page_token='abc', + ), + private_catalog.SearchVersionsResponse( + versions=[], + next_page_token='def', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + ], + next_page_token='ghi', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + ], + ), + RuntimeError, + ) + pages = list(client.search_versions(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_versions_async_pager(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + private_catalog.Version(), + ], + next_page_token='abc', + ), + private_catalog.SearchVersionsResponse( + versions=[], + next_page_token='def', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + ], + next_page_token='ghi', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_versions(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, private_catalog.Version) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_versions_async_pages(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + private_catalog.Version(), + ], + next_page_token='abc', + ), + private_catalog.SearchVersionsResponse( + versions=[], + next_page_token='def', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + ], + next_page_token='ghi', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_versions(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchCatalogsRequest, + dict, +]) +def test_search_catalogs_rest(request_type): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchCatalogsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = private_catalog.SearchCatalogsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.search_catalogs(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchCatalogsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_catalogs_rest_required_fields(request_type=private_catalog.SearchCatalogsRequest): + transport_class = transports.PrivateCatalogRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_catalogs._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_catalogs._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "query", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchCatalogsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = private_catalog.SearchCatalogsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.search_catalogs(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_catalogs_rest_unset_required_fields(): + transport = transports.PrivateCatalogRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_catalogs._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("resource", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_catalogs_rest_interceptors(null_interceptor): + transport = transports.PrivateCatalogRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.PrivateCatalogRestInterceptor(), + ) + client = PrivateCatalogClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "post_search_catalogs") as post, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "pre_search_catalogs") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = private_catalog.SearchCatalogsRequest.pb(private_catalog.SearchCatalogsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = private_catalog.SearchCatalogsResponse.to_json(private_catalog.SearchCatalogsResponse()) + + request = private_catalog.SearchCatalogsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = private_catalog.SearchCatalogsResponse() + + client.search_catalogs(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_catalogs_rest_bad_request(transport: str = 'rest', request_type=private_catalog.SearchCatalogsRequest): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_catalogs(request) + + +def test_search_catalogs_rest_pager(transport: str = 'rest'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + next_page_token='abc', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[], + next_page_token='def', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + ], + next_page_token='ghi', + ), + private_catalog.SearchCatalogsResponse( + catalogs=[ + private_catalog.Catalog(), + private_catalog.Catalog(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(private_catalog.SearchCatalogsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'resource': 'projects/sample1'} + + pager = client.search_catalogs(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Catalog) + for i in results) + + pages = list(client.search_catalogs(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchProductsRequest, + dict, +]) +def test_search_products_rest(request_type): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchProductsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = private_catalog.SearchProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.search_products(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchProductsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_products_rest_required_fields(request_type=private_catalog.SearchProductsRequest): + transport_class = transports.PrivateCatalogRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_products._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_products._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "query", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchProductsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = private_catalog.SearchProductsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.search_products(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_products_rest_unset_required_fields(): + transport = transports.PrivateCatalogRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_products._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("resource", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_products_rest_interceptors(null_interceptor): + transport = transports.PrivateCatalogRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.PrivateCatalogRestInterceptor(), + ) + client = PrivateCatalogClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "post_search_products") as post, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "pre_search_products") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = private_catalog.SearchProductsRequest.pb(private_catalog.SearchProductsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = private_catalog.SearchProductsResponse.to_json(private_catalog.SearchProductsResponse()) + + request = private_catalog.SearchProductsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = private_catalog.SearchProductsResponse() + + client.search_products(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_products_rest_bad_request(transport: str = 'rest', request_type=private_catalog.SearchProductsRequest): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_products(request) + + +def test_search_products_rest_pager(transport: str = 'rest'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + private_catalog.Product(), + ], + next_page_token='abc', + ), + private_catalog.SearchProductsResponse( + products=[], + next_page_token='def', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + ], + next_page_token='ghi', + ), + private_catalog.SearchProductsResponse( + products=[ + private_catalog.Product(), + private_catalog.Product(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(private_catalog.SearchProductsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'resource': 'projects/sample1'} + + pager = client.search_products(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Product) + for i in results) + + pages = list(client.search_products(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + private_catalog.SearchVersionsRequest, + dict, +]) +def test_search_versions_rest(request_type): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchVersionsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = private_catalog.SearchVersionsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.search_versions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchVersionsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_versions_rest_required_fields(request_type=private_catalog.SearchVersionsRequest): + transport_class = transports.PrivateCatalogRestTransport + + request_init = {} + request_init["resource"] = "" + request_init["query"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "query" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_versions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "query" in jsonified_request + assert jsonified_request["query"] == request_init["query"] + + jsonified_request["resource"] = 'resource_value' + jsonified_request["query"] = 'query_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_versions._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", "query", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + assert "query" in jsonified_request + assert jsonified_request["query"] == 'query_value' + + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = private_catalog.SearchVersionsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = private_catalog.SearchVersionsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.search_versions(request) + + expected_params = [ + ( + "query", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_versions_rest_unset_required_fields(): + transport = transports.PrivateCatalogRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_versions._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("resource", "query", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_versions_rest_interceptors(null_interceptor): + transport = transports.PrivateCatalogRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.PrivateCatalogRestInterceptor(), + ) + client = PrivateCatalogClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "post_search_versions") as post, \ + mock.patch.object(transports.PrivateCatalogRestInterceptor, "pre_search_versions") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = private_catalog.SearchVersionsRequest.pb(private_catalog.SearchVersionsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = private_catalog.SearchVersionsResponse.to_json(private_catalog.SearchVersionsResponse()) + + request = private_catalog.SearchVersionsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = private_catalog.SearchVersionsResponse() + + client.search_versions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_versions_rest_bad_request(transport: str = 'rest', request_type=private_catalog.SearchVersionsRequest): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_versions(request) + + +def test_search_versions_rest_pager(transport: str = 'rest'): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + private_catalog.Version(), + ], + next_page_token='abc', + ), + private_catalog.SearchVersionsResponse( + versions=[], + next_page_token='def', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + ], + next_page_token='ghi', + ), + private_catalog.SearchVersionsResponse( + versions=[ + private_catalog.Version(), + private_catalog.Version(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(private_catalog.SearchVersionsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'resource': 'projects/sample1'} + + pager = client.search_versions(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, private_catalog.Version) + for i in results) + + pages = list(client.search_versions(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = PrivateCatalogClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = PrivateCatalogClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = PrivateCatalogClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = PrivateCatalogClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = PrivateCatalogClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.PrivateCatalogGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.PrivateCatalogGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.PrivateCatalogGrpcTransport, + transports.PrivateCatalogGrpcAsyncIOTransport, + transports.PrivateCatalogRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = PrivateCatalogClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.PrivateCatalogGrpcTransport, + ) + +def test_private_catalog_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.PrivateCatalogTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_private_catalog_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.PrivateCatalogTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.PrivateCatalogTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'search_catalogs', + 'search_products', + 'search_versions', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_private_catalog_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.PrivateCatalogTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.PrivateCatalogTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_private_catalog_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.privatecatalog_v1beta1.services.private_catalog.transports.PrivateCatalogTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.PrivateCatalogTransport() + adc.assert_called_once() + + +def test_private_catalog_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + PrivateCatalogClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.PrivateCatalogGrpcTransport, + transports.PrivateCatalogGrpcAsyncIOTransport, + ], +) +def test_private_catalog_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.PrivateCatalogGrpcTransport, + transports.PrivateCatalogGrpcAsyncIOTransport, + transports.PrivateCatalogRestTransport, + ], +) +def test_private_catalog_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.PrivateCatalogGrpcTransport, grpc_helpers), + (transports.PrivateCatalogGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_private_catalog_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "cloudprivatecatalog.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="cloudprivatecatalog.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.PrivateCatalogGrpcTransport, transports.PrivateCatalogGrpcAsyncIOTransport]) +def test_private_catalog_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_private_catalog_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.PrivateCatalogRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_private_catalog_host_no_port(transport_name): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudprivatecatalog.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudprivatecatalog.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudprivatecatalog.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_private_catalog_host_with_port(transport_name): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='cloudprivatecatalog.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'cloudprivatecatalog.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://cloudprivatecatalog.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_private_catalog_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = PrivateCatalogClient( + credentials=creds1, + transport=transport_name, + ) + client2 = PrivateCatalogClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.search_catalogs._session + session2 = client2.transport.search_catalogs._session + assert session1 != session2 + session1 = client1.transport.search_products._session + session2 = client2.transport.search_products._session + assert session1 != session2 + session1 = client1.transport.search_versions._session + session2 = client2.transport.search_versions._session + assert session1 != session2 +def test_private_catalog_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.PrivateCatalogGrpcTransport( + 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_private_catalog_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.PrivateCatalogGrpcAsyncIOTransport( + 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.PrivateCatalogGrpcTransport, transports.PrivateCatalogGrpcAsyncIOTransport]) +def test_private_catalog_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.PrivateCatalogGrpcTransport, transports.PrivateCatalogGrpcAsyncIOTransport]) +def test_private_catalog_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_catalog_path(): + catalog = "squid" + expected = "catalogs/{catalog}".format(catalog=catalog, ) + actual = PrivateCatalogClient.catalog_path(catalog) + assert expected == actual + + +def test_parse_catalog_path(): + expected = { + "catalog": "clam", + } + path = PrivateCatalogClient.catalog_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_catalog_path(path) + assert expected == actual + +def test_product_path(): + product = "whelk" + expected = "products/{product}".format(product=product, ) + actual = PrivateCatalogClient.product_path(product) + assert expected == actual + + +def test_parse_product_path(): + expected = { + "product": "octopus", + } + path = PrivateCatalogClient.product_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_product_path(path) + assert expected == actual + +def test_version_path(): + catalog = "oyster" + product = "nudibranch" + version = "cuttlefish" + expected = "catalogs/{catalog}/products/{product}/versions/{version}".format(catalog=catalog, product=product, version=version, ) + actual = PrivateCatalogClient.version_path(catalog, product, version) + assert expected == actual + + +def test_parse_version_path(): + expected = { + "catalog": "mussel", + "product": "winkle", + "version": "nautilus", + } + path = PrivateCatalogClient.version_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_version_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "scallop" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = PrivateCatalogClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "abalone", + } + path = PrivateCatalogClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "squid" + expected = "folders/{folder}".format(folder=folder, ) + actual = PrivateCatalogClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "clam", + } + path = PrivateCatalogClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "whelk" + expected = "organizations/{organization}".format(organization=organization, ) + actual = PrivateCatalogClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "octopus", + } + path = PrivateCatalogClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "oyster" + expected = "projects/{project}".format(project=project, ) + actual = PrivateCatalogClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nudibranch", + } + path = PrivateCatalogClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "cuttlefish" + location = "mussel" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = PrivateCatalogClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "winkle", + "location": "nautilus", + } + path = PrivateCatalogClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = PrivateCatalogClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.PrivateCatalogTransport, '_prep_wrapped_messages') as prep: + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.PrivateCatalogTransport, '_prep_wrapped_messages') as prep: + transport_class = PrivateCatalogClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = PrivateCatalogAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = PrivateCatalogClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (PrivateCatalogClient, transports.PrivateCatalogGrpcTransport), + (PrivateCatalogAsyncClient, transports.PrivateCatalogGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )