From c2f69680fe038db123896fa4c30c9c5d138663dd Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:30:17 +0000 Subject: [PATCH 1/2] fix: enable self signed jwt for grpc chore: use gapic-generator-python 0.50.5 PiperOrigin-RevId: 386504689 Source-Link: https://github.com/googleapis/googleapis/commit/762094a99ac6e03a17516b13dfbef37927267a70 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6bfc480e1a161d5de121c2bcc3745885d33b265a --- owl-bot-staging/v1/.coveragerc | 17 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + .../apigateway_v1/api_gateway_service.rst | 10 + .../v1/docs/apigateway_v1/services.rst | 6 + .../v1/docs/apigateway_v1/types.rst | 7 + owl-bot-staging/v1/docs/conf.py | 376 ++ owl-bot-staging/v1/docs/index.rst | 7 + .../v1/google/cloud/apigateway/__init__.py | 67 + .../v1/google/cloud/apigateway/py.typed | 2 + .../v1/google/cloud/apigateway_v1/__init__.py | 68 + .../cloud/apigateway_v1/gapic_metadata.json | 173 + .../v1/google/cloud/apigateway_v1/py.typed | 2 + .../cloud/apigateway_v1/services/__init__.py | 15 + .../services/api_gateway_service/__init__.py | 22 + .../api_gateway_service/async_client.py | 1633 ++++++ .../services/api_gateway_service/client.py | 1806 ++++++ .../services/api_gateway_service/pagers.py | 384 ++ .../transports/__init__.py | 33 + .../api_gateway_service/transports/base.py | 434 ++ .../api_gateway_service/transports/grpc.py | 638 ++ .../transports/grpc_asyncio.py | 642 ++ .../cloud/apigateway_v1/types/__init__.py | 64 + .../cloud/apigateway_v1/types/apigateway.py | 941 +++ .../apigateway_v1/types/apigateway_service.py | 25 + owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../scripts/fixup_apigateway_v1_keywords.py | 190 + owl-bot-staging/v1/setup.py | 54 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../unit/gapic/apigateway_v1/__init__.py | 16 + .../apigateway_v1/test_api_gateway_service.py | 5205 +++++++++++++++++ 34 files changed, 13071 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst create mode 100644 owl-bot-staging/v1/docs/apigateway_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/apigateway_v1/types.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/google/cloud/apigateway/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py create mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..a125c0b --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/apigateway/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..2c81722 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/apigateway *.py +recursive-include google/cloud/apigateway_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..d95ca32 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Apigateway 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 Apigateway API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst b/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst new file mode 100644 index 0000000..2f75173 --- /dev/null +++ b/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst @@ -0,0 +1,10 @@ +ApiGatewayService +----------------------------------- + +.. automodule:: google.cloud.apigateway_v1.services.api_gateway_service + :members: + :inherited-members: + +.. automodule:: google.cloud.apigateway_v1.services.api_gateway_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/apigateway_v1/services.rst b/owl-bot-staging/v1/docs/apigateway_v1/services.rst new file mode 100644 index 0000000..46a0db7 --- /dev/null +++ b/owl-bot-staging/v1/docs/apigateway_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Apigateway v1 API +=========================================== +.. toctree:: + :maxdepth: 2 + + api_gateway_service diff --git a/owl-bot-staging/v1/docs/apigateway_v1/types.rst b/owl-bot-staging/v1/docs/apigateway_v1/types.rst new file mode 100644 index 0000000..132f1b0 --- /dev/null +++ b/owl-bot-staging/v1/docs/apigateway_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Apigateway v1 API +======================================== + +.. automodule:: google.cloud.apigateway_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..fa594c9 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-api-gateway documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "1.6.3" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-api-gateway" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-api-gateway-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "google-cloud-api-gateway.tex", + u"google-cloud-api-gateway Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "google-cloud-api-gateway", + u"Google Cloud Apigateway Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "google-cloud-api-gateway", + u"google-cloud-api-gateway Documentation", + author, + "google-cloud-api-gateway", + "GAPIC library for Google Cloud Apigateway API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..aa24547 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + apigateway_v1/services + apigateway_v1/types diff --git a/owl-bot-staging/v1/google/cloud/apigateway/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway/__init__.py new file mode 100644 index 0000000..ba9ade8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway/__init__.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.apigateway_v1.services.api_gateway_service.client import ApiGatewayServiceClient +from google.cloud.apigateway_v1.services.api_gateway_service.async_client import ApiGatewayServiceAsyncClient + +from google.cloud.apigateway_v1.types.apigateway import Api +from google.cloud.apigateway_v1.types.apigateway import ApiConfig +from google.cloud.apigateway_v1.types.apigateway import CreateApiConfigRequest +from google.cloud.apigateway_v1.types.apigateway import CreateApiRequest +from google.cloud.apigateway_v1.types.apigateway import CreateGatewayRequest +from google.cloud.apigateway_v1.types.apigateway import DeleteApiConfigRequest +from google.cloud.apigateway_v1.types.apigateway import DeleteApiRequest +from google.cloud.apigateway_v1.types.apigateway import DeleteGatewayRequest +from google.cloud.apigateway_v1.types.apigateway import Gateway +from google.cloud.apigateway_v1.types.apigateway import GetApiConfigRequest +from google.cloud.apigateway_v1.types.apigateway import GetApiRequest +from google.cloud.apigateway_v1.types.apigateway import GetGatewayRequest +from google.cloud.apigateway_v1.types.apigateway import ListApiConfigsRequest +from google.cloud.apigateway_v1.types.apigateway import ListApiConfigsResponse +from google.cloud.apigateway_v1.types.apigateway import ListApisRequest +from google.cloud.apigateway_v1.types.apigateway import ListApisResponse +from google.cloud.apigateway_v1.types.apigateway import ListGatewaysRequest +from google.cloud.apigateway_v1.types.apigateway import ListGatewaysResponse +from google.cloud.apigateway_v1.types.apigateway import OperationMetadata +from google.cloud.apigateway_v1.types.apigateway import UpdateApiConfigRequest +from google.cloud.apigateway_v1.types.apigateway import UpdateApiRequest +from google.cloud.apigateway_v1.types.apigateway import UpdateGatewayRequest + +__all__ = ('ApiGatewayServiceClient', + 'ApiGatewayServiceAsyncClient', + 'Api', + 'ApiConfig', + 'CreateApiConfigRequest', + 'CreateApiRequest', + 'CreateGatewayRequest', + 'DeleteApiConfigRequest', + 'DeleteApiRequest', + 'DeleteGatewayRequest', + 'Gateway', + 'GetApiConfigRequest', + 'GetApiRequest', + 'GetGatewayRequest', + 'ListApiConfigsRequest', + 'ListApiConfigsResponse', + 'ListApisRequest', + 'ListApisResponse', + 'ListGatewaysRequest', + 'ListGatewaysResponse', + 'OperationMetadata', + 'UpdateApiConfigRequest', + 'UpdateApiRequest', + 'UpdateGatewayRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway/py.typed b/owl-bot-staging/v1/google/cloud/apigateway/py.typed new file mode 100644 index 0000000..49728b7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-api-gateway package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py new file mode 100644 index 0000000..f9b2401 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.api_gateway_service import ApiGatewayServiceClient +from .services.api_gateway_service import ApiGatewayServiceAsyncClient + +from .types.apigateway import Api +from .types.apigateway import ApiConfig +from .types.apigateway import CreateApiConfigRequest +from .types.apigateway import CreateApiRequest +from .types.apigateway import CreateGatewayRequest +from .types.apigateway import DeleteApiConfigRequest +from .types.apigateway import DeleteApiRequest +from .types.apigateway import DeleteGatewayRequest +from .types.apigateway import Gateway +from .types.apigateway import GetApiConfigRequest +from .types.apigateway import GetApiRequest +from .types.apigateway import GetGatewayRequest +from .types.apigateway import ListApiConfigsRequest +from .types.apigateway import ListApiConfigsResponse +from .types.apigateway import ListApisRequest +from .types.apigateway import ListApisResponse +from .types.apigateway import ListGatewaysRequest +from .types.apigateway import ListGatewaysResponse +from .types.apigateway import OperationMetadata +from .types.apigateway import UpdateApiConfigRequest +from .types.apigateway import UpdateApiRequest +from .types.apigateway import UpdateGatewayRequest + +__all__ = ( + 'ApiGatewayServiceAsyncClient', +'Api', +'ApiConfig', +'ApiGatewayServiceClient', +'CreateApiConfigRequest', +'CreateApiRequest', +'CreateGatewayRequest', +'DeleteApiConfigRequest', +'DeleteApiRequest', +'DeleteGatewayRequest', +'Gateway', +'GetApiConfigRequest', +'GetApiRequest', +'GetGatewayRequest', +'ListApiConfigsRequest', +'ListApiConfigsResponse', +'ListApisRequest', +'ListApisResponse', +'ListGatewaysRequest', +'ListGatewaysResponse', +'OperationMetadata', +'UpdateApiConfigRequest', +'UpdateApiRequest', +'UpdateGatewayRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json new file mode 100644 index 0000000..2e07036 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json @@ -0,0 +1,173 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.apigateway_v1", + "protoPackage": "google.cloud.apigateway.v1", + "schema": "1.0", + "services": { + "ApiGatewayService": { + "clients": { + "grpc": { + "libraryClient": "ApiGatewayServiceClient", + "rpcs": { + "CreateApi": { + "methods": [ + "create_api" + ] + }, + "CreateApiConfig": { + "methods": [ + "create_api_config" + ] + }, + "CreateGateway": { + "methods": [ + "create_gateway" + ] + }, + "DeleteApi": { + "methods": [ + "delete_api" + ] + }, + "DeleteApiConfig": { + "methods": [ + "delete_api_config" + ] + }, + "DeleteGateway": { + "methods": [ + "delete_gateway" + ] + }, + "GetApi": { + "methods": [ + "get_api" + ] + }, + "GetApiConfig": { + "methods": [ + "get_api_config" + ] + }, + "GetGateway": { + "methods": [ + "get_gateway" + ] + }, + "ListApiConfigs": { + "methods": [ + "list_api_configs" + ] + }, + "ListApis": { + "methods": [ + "list_apis" + ] + }, + "ListGateways": { + "methods": [ + "list_gateways" + ] + }, + "UpdateApi": { + "methods": [ + "update_api" + ] + }, + "UpdateApiConfig": { + "methods": [ + "update_api_config" + ] + }, + "UpdateGateway": { + "methods": [ + "update_gateway" + ] + } + } + }, + "grpc-async": { + "libraryClient": "ApiGatewayServiceAsyncClient", + "rpcs": { + "CreateApi": { + "methods": [ + "create_api" + ] + }, + "CreateApiConfig": { + "methods": [ + "create_api_config" + ] + }, + "CreateGateway": { + "methods": [ + "create_gateway" + ] + }, + "DeleteApi": { + "methods": [ + "delete_api" + ] + }, + "DeleteApiConfig": { + "methods": [ + "delete_api_config" + ] + }, + "DeleteGateway": { + "methods": [ + "delete_gateway" + ] + }, + "GetApi": { + "methods": [ + "get_api" + ] + }, + "GetApiConfig": { + "methods": [ + "get_api_config" + ] + }, + "GetGateway": { + "methods": [ + "get_gateway" + ] + }, + "ListApiConfigs": { + "methods": [ + "list_api_configs" + ] + }, + "ListApis": { + "methods": [ + "list_apis" + ] + }, + "ListGateways": { + "methods": [ + "list_gateways" + ] + }, + "UpdateApi": { + "methods": [ + "update_api" + ] + }, + "UpdateApiConfig": { + "methods": [ + "update_api_config" + ] + }, + "UpdateGateway": { + "methods": [ + "update_gateway" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed b/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed new file mode 100644 index 0000000..49728b7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-api-gateway package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py new file mode 100644 index 0000000..3683170 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import ApiGatewayServiceClient +from .async_client import ApiGatewayServiceAsyncClient + +__all__ = ( + 'ApiGatewayServiceClient', + 'ApiGatewayServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py new file mode 100644 index 0000000..0785110 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py @@ -0,0 +1,1633 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.apigateway_v1.services.api_gateway_service import pagers +from google.cloud.apigateway_v1.types import apigateway +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport +from .client import ApiGatewayServiceClient + + +class ApiGatewayServiceAsyncClient: + """The API Gateway Service is the interface for managing API + Gateways. + """ + + _client: ApiGatewayServiceClient + + DEFAULT_ENDPOINT = ApiGatewayServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = ApiGatewayServiceClient.DEFAULT_MTLS_ENDPOINT + + api_path = staticmethod(ApiGatewayServiceClient.api_path) + parse_api_path = staticmethod(ApiGatewayServiceClient.parse_api_path) + api_config_path = staticmethod(ApiGatewayServiceClient.api_config_path) + parse_api_config_path = staticmethod(ApiGatewayServiceClient.parse_api_config_path) + gateway_path = staticmethod(ApiGatewayServiceClient.gateway_path) + parse_gateway_path = staticmethod(ApiGatewayServiceClient.parse_gateway_path) + managed_service_path = staticmethod(ApiGatewayServiceClient.managed_service_path) + parse_managed_service_path = staticmethod(ApiGatewayServiceClient.parse_managed_service_path) + service_path = staticmethod(ApiGatewayServiceClient.service_path) + parse_service_path = staticmethod(ApiGatewayServiceClient.parse_service_path) + service_account_path = staticmethod(ApiGatewayServiceClient.service_account_path) + parse_service_account_path = staticmethod(ApiGatewayServiceClient.parse_service_account_path) + common_billing_account_path = staticmethod(ApiGatewayServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(ApiGatewayServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(ApiGatewayServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(ApiGatewayServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(ApiGatewayServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(ApiGatewayServiceClient.parse_common_organization_path) + common_project_path = staticmethod(ApiGatewayServiceClient.common_project_path) + parse_common_project_path = staticmethod(ApiGatewayServiceClient.parse_common_project_path) + common_location_path = staticmethod(ApiGatewayServiceClient.common_location_path) + parse_common_location_path = staticmethod(ApiGatewayServiceClient.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: + ApiGatewayServiceAsyncClient: The constructed client. + """ + return ApiGatewayServiceClient.from_service_account_info.__func__(ApiGatewayServiceAsyncClient, 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: + ApiGatewayServiceAsyncClient: The constructed client. + """ + return ApiGatewayServiceClient.from_service_account_file.__func__(ApiGatewayServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> ApiGatewayServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ApiGatewayServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(ApiGatewayServiceClient).get_transport_class, type(ApiGatewayServiceClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, ApiGatewayServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the api gateway service 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, ~.ApiGatewayServiceTransport]): 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 = ApiGatewayServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_gateways(self, + request: apigateway.ListGatewaysRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListGatewaysAsyncPager: + r"""Lists Gateways in a given project and location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.ListGatewaysRequest`): + The request object. Request message for + ApiGatewayService.ListGateways + parent (:class:`str`): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysAsyncPager: + Response message for + ApiGatewayService.ListGateways + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.ListGatewaysRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_gateways, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListGatewaysAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_gateway(self, + request: apigateway.GetGatewayRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.Gateway: + r"""Gets details of a single Gateway. + + Args: + request (:class:`google.cloud.apigateway_v1.types.GetGatewayRequest`): + The request object. Request message for + ApiGatewayService.GetGateway + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.Gateway: + A Gateway is an API-aware HTTP proxy. + It performs API-Method and/or API- + Consumer specific actions based on an + API Config such as authentication, + policy enforcement, and backend + selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.GetGatewayRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_gateway, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_gateway(self, + request: apigateway.CreateGatewayRequest = None, + *, + parent: str = None, + gateway: apigateway.Gateway = None, + gateway_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a new Gateway in a given project and + location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.CreateGatewayRequest`): + The request object. Request message for + ApiGatewayService.CreateGateway + parent (:class:`str`): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + gateway (:class:`google.cloud.apigateway_v1.types.Gateway`): + Required. Gateway resource. + This corresponds to the ``gateway`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + gateway_id (:class:`str`): + Required. Identifier to assign to the + Gateway. Must be unique within scope of + the parent resource. + + This corresponds to the ``gateway_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or + API-Consumer specific actions based on an API Config + such as authentication, policy enforcement, and + backend selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, gateway, gateway_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.CreateGatewayRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if gateway is not None: + request.gateway = gateway + if gateway_id is not None: + request.gateway_id = gateway_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.Gateway, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_gateway(self, + request: apigateway.UpdateGatewayRequest = None, + *, + gateway: apigateway.Gateway = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the parameters of a single Gateway. + + Args: + request (:class:`google.cloud.apigateway_v1.types.UpdateGatewayRequest`): + The request object. Request message for + ApiGatewayService.UpdateGateway + gateway (:class:`google.cloud.apigateway_v1.types.Gateway`): + Required. Gateway resource. + This corresponds to the ``gateway`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Field mask is used to specify the fields to be + overwritten in the Gateway resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or + API-Consumer specific actions based on an API Config + such as authentication, policy enforcement, and + backend selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([gateway, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.UpdateGatewayRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if gateway is not None: + request.gateway = gateway + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("gateway.name", request.gateway.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.Gateway, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_gateway(self, + request: apigateway.DeleteGatewayRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a single Gateway. + + Args: + request (:class:`google.cloud.apigateway_v1.types.DeleteGatewayRequest`): + The request object. Request message for + ApiGatewayService.DeleteGateway + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.DeleteGatewayRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_apis(self, + request: apigateway.ListApisRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListApisAsyncPager: + r"""Lists Apis in a given project and location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.ListApisRequest`): + The request object. Request message for + ApiGatewayService.ListApis + parent (:class:`str`): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisAsyncPager: + Response message for + ApiGatewayService.ListApis + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.ListApisRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_apis, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListApisAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_api(self, + request: apigateway.GetApiRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.Api: + r"""Gets details of a single Api. + + Args: + request (:class:`google.cloud.apigateway_v1.types.GetApiRequest`): + The request object. Request message for + ApiGatewayService.GetApi + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.Api: + An API that can be served by one or + more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.GetApiRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_api, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_api(self, + request: apigateway.CreateApiRequest = None, + *, + parent: str = None, + api: apigateway.Api = None, + api_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a new Api in a given project and location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.CreateApiRequest`): + The request object. Request message for + ApiGatewayService.CreateApi + parent (:class:`str`): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api (:class:`google.cloud.apigateway_v1.types.Api`): + Required. API resource. + This corresponds to the ``api`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_id (:class:`str`): + Required. Identifier to assign to the + API. Must be unique within scope of the + parent resource. + + This corresponds to the ``api_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.apigateway_v1.types.Api` An API + that can be served by one or more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, api, api_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.CreateApiRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if api is not None: + request.api = api + if api_id is not None: + request.api_id = api_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.Api, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_api(self, + request: apigateway.UpdateApiRequest = None, + *, + api: apigateway.Api = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the parameters of a single Api. + + Args: + request (:class:`google.cloud.apigateway_v1.types.UpdateApiRequest`): + The request object. Request message for + ApiGatewayService.UpdateApi + api (:class:`google.cloud.apigateway_v1.types.Api`): + Required. API resource. + This corresponds to the ``api`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Field mask is used to specify the fields to be + overwritten in the Api resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.apigateway_v1.types.Api` An API + that can be served by one or more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([api, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.UpdateApiRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if api is not None: + request.api = api + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("api.name", request.api.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.Api, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_api(self, + request: apigateway.DeleteApiRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a single Api. + + Args: + request (:class:`google.cloud.apigateway_v1.types.DeleteApiRequest`): + The request object. Request message for + ApiGatewayService.DeleteApi + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.DeleteApiRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_api_configs(self, + request: apigateway.ListApiConfigsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListApiConfigsAsyncPager: + r"""Lists ApiConfigs in a given project and location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.ListApiConfigsRequest`): + The request object. Request message for + ApiGatewayService.ListApiConfigs + parent (:class:`str`): + Required. Parent resource of the API Config, of the + form: ``projects/*/locations/global/apis/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsAsyncPager: + Response message for + ApiGatewayService.ListApiConfigs + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.ListApiConfigsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_api_configs, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListApiConfigsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_api_config(self, + request: apigateway.GetApiConfigRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.ApiConfig: + r"""Gets details of a single ApiConfig. + + Args: + request (:class:`google.cloud.apigateway_v1.types.GetApiConfigRequest`): + The request object. Request message for + ApiGatewayService.GetApiConfig + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.ApiConfig: + An API Configuration is a combination + of settings for both the Managed Service + and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.GetApiConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_api_config, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_api_config(self, + request: apigateway.CreateApiConfigRequest = None, + *, + parent: str = None, + api_config: apigateway.ApiConfig = None, + api_config_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a new ApiConfig in a given project and + location. + + Args: + request (:class:`google.cloud.apigateway_v1.types.CreateApiConfigRequest`): + The request object. Request message for + ApiGatewayService.CreateApiConfig + parent (:class:`str`): + Required. Parent resource of the API Config, of the + form: ``projects/*/locations/global/apis/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_config (:class:`google.cloud.apigateway_v1.types.ApiConfig`): + Required. API resource. + This corresponds to the ``api_config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_config_id (:class:`str`): + Required. Identifier to assign to the + API Config. Must be unique within scope + of the parent resource. + + This corresponds to the ``api_config_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed + Service and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, api_config, api_config_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.CreateApiConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if api_config is not None: + request.api_config = api_config + if api_config_id is not None: + request.api_config_id = api_config_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.ApiConfig, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_api_config(self, + request: apigateway.UpdateApiConfigRequest = None, + *, + api_config: apigateway.ApiConfig = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the parameters of a single ApiConfig. + + Args: + request (:class:`google.cloud.apigateway_v1.types.UpdateApiConfigRequest`): + The request object. Request message for + ApiGatewayService.UpdateApiConfig + api_config (:class:`google.cloud.apigateway_v1.types.ApiConfig`): + Required. API Config resource. + This corresponds to the ``api_config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Field mask is used to specify the fields to be + overwritten in the ApiConfig resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed + Service and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([api_config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.UpdateApiConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if api_config is not None: + request.api_config = api_config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("api_config.name", request.api_config.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + apigateway.ApiConfig, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_api_config(self, + request: apigateway.DeleteApiConfigRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a single ApiConfig. + + Args: + request (:class:`google.cloud.apigateway_v1.types.DeleteApiConfigRequest`): + The request object. Request message for + ApiGatewayService.DeleteApiConfig + name (:class:`str`): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = apigateway.DeleteApiConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-api-gateway", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "ApiGatewayServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py new file mode 100644 index 0000000..24015bf --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py @@ -0,0 +1,1806 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.apigateway_v1.services.api_gateway_service import pagers +from google.cloud.apigateway_v1.types import apigateway +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import ApiGatewayServiceGrpcTransport +from .transports.grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport + + +class ApiGatewayServiceClientMeta(type): + """Metaclass for the ApiGatewayService 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[ApiGatewayServiceTransport]] + _transport_registry["grpc"] = ApiGatewayServiceGrpcTransport + _transport_registry["grpc_asyncio"] = ApiGatewayServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[ApiGatewayServiceTransport]: + """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 ApiGatewayServiceClient(metaclass=ApiGatewayServiceClientMeta): + """The API Gateway Service is the interface for managing API + Gateways. + """ + + @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 = "apigateway.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: + ApiGatewayServiceClient: 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: + ApiGatewayServiceClient: 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) -> ApiGatewayServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ApiGatewayServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def api_path(project: str,api: str,) -> str: + """Returns a fully-qualified api string.""" + return "projects/{project}/locations/global/apis/{api}".format(project=project, api=api, ) + + @staticmethod + def parse_api_path(path: str) -> Dict[str,str]: + """Parses a api path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/global/apis/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def api_config_path(project: str,api: str,api_config: str,) -> str: + """Returns a fully-qualified api_config string.""" + return "projects/{project}/locations/global/apis/{api}/configs/{api_config}".format(project=project, api=api, api_config=api_config, ) + + @staticmethod + def parse_api_config_path(path: str) -> Dict[str,str]: + """Parses a api_config path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/global/apis/(?P.+?)/configs/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def gateway_path(project: str,location: str,gateway: str,) -> str: + """Returns a fully-qualified gateway string.""" + return "projects/{project}/locations/{location}/gateways/{gateway}".format(project=project, location=location, gateway=gateway, ) + + @staticmethod + def parse_gateway_path(path: str) -> Dict[str,str]: + """Parses a gateway path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/gateways/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def managed_service_path(service: str,) -> str: + """Returns a fully-qualified managed_service string.""" + return "services/{service}".format(service=service, ) + + @staticmethod + def parse_managed_service_path(path: str) -> Dict[str,str]: + """Parses a managed_service path into its component segments.""" + m = re.match(r"^services/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def service_path(service: str,config: str,) -> str: + """Returns a fully-qualified service string.""" + return "services/{service}/configs/{config}".format(service=service, config=config, ) + + @staticmethod + def parse_service_path(path: str) -> Dict[str,str]: + """Parses a service path into its component segments.""" + m = re.match(r"^services/(?P.+?)/configs/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def service_account_path(project: str,service_account: str,) -> str: + """Returns a fully-qualified service_account string.""" + return "projects/{project}/serviceAccounts/{service_account}".format(project=project, service_account=service_account, ) + + @staticmethod + def parse_service_account_path(path: str) -> Dict[str,str]: + """Parses a service_account path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/serviceAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, ApiGatewayServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the api gateway service 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, ApiGatewayServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, ApiGatewayServiceTransport): + # transport is a ApiGatewayServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), + ) + + def list_gateways(self, + request: apigateway.ListGatewaysRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListGatewaysPager: + r"""Lists Gateways in a given project and location. + + Args: + request (google.cloud.apigateway_v1.types.ListGatewaysRequest): + The request object. Request message for + ApiGatewayService.ListGateways + parent (str): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysPager: + Response message for + ApiGatewayService.ListGateways + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.ListGatewaysRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.ListGatewaysRequest): + request = apigateway.ListGatewaysRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_gateways] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListGatewaysPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_gateway(self, + request: apigateway.GetGatewayRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.Gateway: + r"""Gets details of a single Gateway. + + Args: + request (google.cloud.apigateway_v1.types.GetGatewayRequest): + The request object. Request message for + ApiGatewayService.GetGateway + name (str): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.Gateway: + A Gateway is an API-aware HTTP proxy. + It performs API-Method and/or API- + Consumer specific actions based on an + API Config such as authentication, + policy enforcement, and backend + selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.GetGatewayRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.GetGatewayRequest): + request = apigateway.GetGatewayRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_gateway] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_gateway(self, + request: apigateway.CreateGatewayRequest = None, + *, + parent: str = None, + gateway: apigateway.Gateway = None, + gateway_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a new Gateway in a given project and + location. + + Args: + request (google.cloud.apigateway_v1.types.CreateGatewayRequest): + The request object. Request message for + ApiGatewayService.CreateGateway + parent (str): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + gateway (google.cloud.apigateway_v1.types.Gateway): + Required. Gateway resource. + This corresponds to the ``gateway`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + gateway_id (str): + Required. Identifier to assign to the + Gateway. Must be unique within scope of + the parent resource. + + This corresponds to the ``gateway_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or + API-Consumer specific actions based on an API Config + such as authentication, policy enforcement, and + backend selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, gateway, gateway_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.CreateGatewayRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.CreateGatewayRequest): + request = apigateway.CreateGatewayRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if gateway is not None: + request.gateway = gateway + if gateway_id is not None: + request.gateway_id = gateway_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_gateway] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.Gateway, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_gateway(self, + request: apigateway.UpdateGatewayRequest = None, + *, + gateway: apigateway.Gateway = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the parameters of a single Gateway. + + Args: + request (google.cloud.apigateway_v1.types.UpdateGatewayRequest): + The request object. Request message for + ApiGatewayService.UpdateGateway + gateway (google.cloud.apigateway_v1.types.Gateway): + Required. Gateway resource. + This corresponds to the ``gateway`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be + overwritten in the Gateway resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or + API-Consumer specific actions based on an API Config + such as authentication, policy enforcement, and + backend selection. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([gateway, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.UpdateGatewayRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.UpdateGatewayRequest): + request = apigateway.UpdateGatewayRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if gateway is not None: + request.gateway = gateway + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_gateway] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("gateway.name", request.gateway.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.Gateway, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_gateway(self, + request: apigateway.DeleteGatewayRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a single Gateway. + + Args: + request (google.cloud.apigateway_v1.types.DeleteGatewayRequest): + The request object. Request message for + ApiGatewayService.DeleteGateway + name (str): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.DeleteGatewayRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.DeleteGatewayRequest): + request = apigateway.DeleteGatewayRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_gateway] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_apis(self, + request: apigateway.ListApisRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListApisPager: + r"""Lists Apis in a given project and location. + + Args: + request (google.cloud.apigateway_v1.types.ListApisRequest): + The request object. Request message for + ApiGatewayService.ListApis + parent (str): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisPager: + Response message for + ApiGatewayService.ListApis + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.ListApisRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.ListApisRequest): + request = apigateway.ListApisRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_apis] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListApisPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_api(self, + request: apigateway.GetApiRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.Api: + r"""Gets details of a single Api. + + Args: + request (google.cloud.apigateway_v1.types.GetApiRequest): + The request object. Request message for + ApiGatewayService.GetApi + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.Api: + An API that can be served by one or + more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.GetApiRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.GetApiRequest): + request = apigateway.GetApiRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_api] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_api(self, + request: apigateway.CreateApiRequest = None, + *, + parent: str = None, + api: apigateway.Api = None, + api_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a new Api in a given project and location. + + Args: + request (google.cloud.apigateway_v1.types.CreateApiRequest): + The request object. Request message for + ApiGatewayService.CreateApi + parent (str): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api (google.cloud.apigateway_v1.types.Api): + Required. API resource. + This corresponds to the ``api`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_id (str): + Required. Identifier to assign to the + API. Must be unique within scope of the + parent resource. + + This corresponds to the ``api_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.apigateway_v1.types.Api` An API + that can be served by one or more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, api, api_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.CreateApiRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.CreateApiRequest): + request = apigateway.CreateApiRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if api is not None: + request.api = api + if api_id is not None: + request.api_id = api_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_api] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.Api, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_api(self, + request: apigateway.UpdateApiRequest = None, + *, + api: apigateway.Api = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the parameters of a single Api. + + Args: + request (google.cloud.apigateway_v1.types.UpdateApiRequest): + The request object. Request message for + ApiGatewayService.UpdateApi + api (google.cloud.apigateway_v1.types.Api): + Required. API resource. + This corresponds to the ``api`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be + overwritten in the Api resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.apigateway_v1.types.Api` An API + that can be served by one or more Gateways. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([api, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.UpdateApiRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.UpdateApiRequest): + request = apigateway.UpdateApiRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if api is not None: + request.api = api + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_api] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("api.name", request.api.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.Api, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_api(self, + request: apigateway.DeleteApiRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a single Api. + + Args: + request (google.cloud.apigateway_v1.types.DeleteApiRequest): + The request object. Request message for + ApiGatewayService.DeleteApi + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.DeleteApiRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.DeleteApiRequest): + request = apigateway.DeleteApiRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_api] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_api_configs(self, + request: apigateway.ListApiConfigsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListApiConfigsPager: + r"""Lists ApiConfigs in a given project and location. + + Args: + request (google.cloud.apigateway_v1.types.ListApiConfigsRequest): + The request object. Request message for + ApiGatewayService.ListApiConfigs + parent (str): + Required. Parent resource of the API Config, of the + form: ``projects/*/locations/global/apis/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsPager: + Response message for + ApiGatewayService.ListApiConfigs + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.ListApiConfigsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.ListApiConfigsRequest): + request = apigateway.ListApiConfigsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_api_configs] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListApiConfigsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_api_config(self, + request: apigateway.GetApiConfigRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> apigateway.ApiConfig: + r"""Gets details of a single ApiConfig. + + Args: + request (google.cloud.apigateway_v1.types.GetApiConfigRequest): + The request object. Request message for + ApiGatewayService.GetApiConfig + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.apigateway_v1.types.ApiConfig: + An API Configuration is a combination + of settings for both the Managed Service + and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.GetApiConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.GetApiConfigRequest): + request = apigateway.GetApiConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_api_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_api_config(self, + request: apigateway.CreateApiConfigRequest = None, + *, + parent: str = None, + api_config: apigateway.ApiConfig = None, + api_config_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a new ApiConfig in a given project and + location. + + Args: + request (google.cloud.apigateway_v1.types.CreateApiConfigRequest): + The request object. Request message for + ApiGatewayService.CreateApiConfig + parent (str): + Required. Parent resource of the API Config, of the + form: ``projects/*/locations/global/apis/*`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_config (google.cloud.apigateway_v1.types.ApiConfig): + Required. API resource. + This corresponds to the ``api_config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + api_config_id (str): + Required. Identifier to assign to the + API Config. Must be unique within scope + of the parent resource. + + This corresponds to the ``api_config_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed + Service and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, api_config, api_config_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.CreateApiConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.CreateApiConfigRequest): + request = apigateway.CreateApiConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if api_config is not None: + request.api_config = api_config + if api_config_id is not None: + request.api_config_id = api_config_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_api_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.ApiConfig, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_api_config(self, + request: apigateway.UpdateApiConfigRequest = None, + *, + api_config: apigateway.ApiConfig = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the parameters of a single ApiConfig. + + Args: + request (google.cloud.apigateway_v1.types.UpdateApiConfigRequest): + The request object. Request message for + ApiGatewayService.UpdateApiConfig + api_config (google.cloud.apigateway_v1.types.ApiConfig): + Required. API Config resource. + This corresponds to the ``api_config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be + overwritten in the ApiConfig resource by the update. The + fields specified in the update_mask are relative to the + resource, not the full request. A field will be + overwritten if it is in the mask. If the user does not + provide a mask then all fields will be overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed + Service and Gateways serving this API Config. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([api_config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.UpdateApiConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.UpdateApiConfigRequest): + request = apigateway.UpdateApiConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if api_config is not None: + request.api_config = api_config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_api_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("api_config.name", request.api_config.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + apigateway.ApiConfig, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_api_config(self, + request: apigateway.DeleteApiConfigRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a single ApiConfig. + + Args: + request (google.cloud.apigateway_v1.types.DeleteApiConfigRequest): + The request object. Request message for + ApiGatewayService.DeleteApiConfig + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a apigateway.DeleteApiConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, apigateway.DeleteApiConfigRequest): + request = apigateway.DeleteApiConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_api_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=apigateway.OperationMetadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-api-gateway", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "ApiGatewayServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py new file mode 100644 index 0000000..e36acb8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py @@ -0,0 +1,384 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional + +from google.cloud.apigateway_v1.types import apigateway + + +class ListGatewaysPager: + """A pager for iterating through ``list_gateways`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` object, and + provides an ``__iter__`` method to iterate through its + ``gateways`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListGateways`` requests and continue to iterate + through the ``gateways`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` + 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[..., apigateway.ListGatewaysResponse], + request: apigateway.ListGatewaysRequest, + response: apigateway.ListGatewaysResponse, + *, + 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.apigateway_v1.types.ListGatewaysRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListGatewaysResponse): + 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 = apigateway.ListGatewaysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[apigateway.ListGatewaysResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[apigateway.Gateway]: + for page in self.pages: + yield from page.gateways + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListGatewaysAsyncPager: + """A pager for iterating through ``list_gateways`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``gateways`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListGateways`` requests and continue to iterate + through the ``gateways`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` + 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[apigateway.ListGatewaysResponse]], + request: apigateway.ListGatewaysRequest, + response: apigateway.ListGatewaysResponse, + *, + 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.apigateway_v1.types.ListGatewaysRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListGatewaysResponse): + 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 = apigateway.ListGatewaysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[apigateway.ListGatewaysResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[apigateway.Gateway]: + async def async_generator(): + async for page in self.pages: + for response in page.gateways: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListApisPager: + """A pager for iterating through ``list_apis`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListApisResponse` object, and + provides an ``__iter__`` method to iterate through its + ``apis`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListApis`` requests and continue to iterate + through the ``apis`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListApisResponse` + 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[..., apigateway.ListApisResponse], + request: apigateway.ListApisRequest, + response: apigateway.ListApisResponse, + *, + 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.apigateway_v1.types.ListApisRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListApisResponse): + 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 = apigateway.ListApisRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[apigateway.ListApisResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[apigateway.Api]: + for page in self.pages: + yield from page.apis + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListApisAsyncPager: + """A pager for iterating through ``list_apis`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListApisResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``apis`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListApis`` requests and continue to iterate + through the ``apis`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListApisResponse` + 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[apigateway.ListApisResponse]], + request: apigateway.ListApisRequest, + response: apigateway.ListApisResponse, + *, + 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.apigateway_v1.types.ListApisRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListApisResponse): + 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 = apigateway.ListApisRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[apigateway.ListApisResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[apigateway.Api]: + async def async_generator(): + async for page in self.pages: + for response in page.apis: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListApiConfigsPager: + """A pager for iterating through ``list_api_configs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``api_configs`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListApiConfigs`` requests and continue to iterate + through the ``api_configs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` + 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[..., apigateway.ListApiConfigsResponse], + request: apigateway.ListApiConfigsRequest, + response: apigateway.ListApiConfigsResponse, + *, + 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.apigateway_v1.types.ListApiConfigsRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListApiConfigsResponse): + 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 = apigateway.ListApiConfigsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[apigateway.ListApiConfigsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[apigateway.ApiConfig]: + for page in self.pages: + yield from page.api_configs + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListApiConfigsAsyncPager: + """A pager for iterating through ``list_api_configs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``api_configs`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListApiConfigs`` requests and continue to iterate + through the ``api_configs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` + 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[apigateway.ListApiConfigsResponse]], + request: apigateway.ListApiConfigsRequest, + response: apigateway.ListApiConfigsResponse, + *, + 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.apigateway_v1.types.ListApiConfigsRequest): + The initial request object. + response (google.cloud.apigateway_v1.types.ListApiConfigsResponse): + 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 = apigateway.ListApiConfigsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[apigateway.ListApiConfigsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[apigateway.ApiConfig]: + async def async_generator(): + async for page in self.pages: + for response in page.api_configs: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py new file mode 100644 index 0000000..d6a7980 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import ApiGatewayServiceTransport +from .grpc import ApiGatewayServiceGrpcTransport +from .grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[ApiGatewayServiceTransport]] +_transport_registry['grpc'] = ApiGatewayServiceGrpcTransport +_transport_registry['grpc_asyncio'] = ApiGatewayServiceGrpcAsyncIOTransport + +__all__ = ( + 'ApiGatewayServiceTransport', + 'ApiGatewayServiceGrpcTransport', + 'ApiGatewayServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py new file mode 100644 index 0000000..56d62e8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py @@ -0,0 +1,434 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.apigateway_v1.types import apigateway +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-api-gateway', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class ApiGatewayServiceTransport(abc.ABC): + """Abstract transport class for ApiGatewayService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'apigateway.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_gateways: gapic_v1.method.wrap_method( + self.list_gateways, + default_timeout=None, + client_info=client_info, + ), + self.get_gateway: gapic_v1.method.wrap_method( + self.get_gateway, + default_timeout=None, + client_info=client_info, + ), + self.create_gateway: gapic_v1.method.wrap_method( + self.create_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_gateway: gapic_v1.method.wrap_method( + self.update_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_gateway: gapic_v1.method.wrap_method( + self.delete_gateway, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_apis: gapic_v1.method.wrap_method( + self.list_apis, + default_timeout=None, + client_info=client_info, + ), + self.get_api: gapic_v1.method.wrap_method( + self.get_api, + default_timeout=None, + client_info=client_info, + ), + self.create_api: gapic_v1.method.wrap_method( + self.create_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_api: gapic_v1.method.wrap_method( + self.update_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_api: gapic_v1.method.wrap_method( + self.delete_api, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_api_configs: gapic_v1.method.wrap_method( + self.list_api_configs, + default_timeout=None, + client_info=client_info, + ), + self.get_api_config: gapic_v1.method.wrap_method( + self.get_api_config, + default_timeout=None, + client_info=client_info, + ), + self.create_api_config: gapic_v1.method.wrap_method( + self.create_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_api_config: gapic_v1.method.wrap_method( + self.update_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_api_config: gapic_v1.method.wrap_method( + self.delete_api_config, + default_retry=retries.Retry( +initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + core_exceptions.Unknown, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def list_gateways(self) -> Callable[ + [apigateway.ListGatewaysRequest], + Union[ + apigateway.ListGatewaysResponse, + Awaitable[apigateway.ListGatewaysResponse] + ]]: + raise NotImplementedError() + + @property + def get_gateway(self) -> Callable[ + [apigateway.GetGatewayRequest], + Union[ + apigateway.Gateway, + Awaitable[apigateway.Gateway] + ]]: + raise NotImplementedError() + + @property + def create_gateway(self) -> Callable[ + [apigateway.CreateGatewayRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def update_gateway(self) -> Callable[ + [apigateway.UpdateGatewayRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_gateway(self) -> Callable[ + [apigateway.DeleteGatewayRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_apis(self) -> Callable[ + [apigateway.ListApisRequest], + Union[ + apigateway.ListApisResponse, + Awaitable[apigateway.ListApisResponse] + ]]: + raise NotImplementedError() + + @property + def get_api(self) -> Callable[ + [apigateway.GetApiRequest], + Union[ + apigateway.Api, + Awaitable[apigateway.Api] + ]]: + raise NotImplementedError() + + @property + def create_api(self) -> Callable[ + [apigateway.CreateApiRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def update_api(self) -> Callable[ + [apigateway.UpdateApiRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_api(self) -> Callable[ + [apigateway.DeleteApiRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_api_configs(self) -> Callable[ + [apigateway.ListApiConfigsRequest], + Union[ + apigateway.ListApiConfigsResponse, + Awaitable[apigateway.ListApiConfigsResponse] + ]]: + raise NotImplementedError() + + @property + def get_api_config(self) -> Callable[ + [apigateway.GetApiConfigRequest], + Union[ + apigateway.ApiConfig, + Awaitable[apigateway.ApiConfig] + ]]: + raise NotImplementedError() + + @property + def create_api_config(self) -> Callable[ + [apigateway.CreateApiConfigRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def update_api_config(self) -> Callable[ + [apigateway.UpdateApiConfigRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_api_config(self) -> Callable[ + [apigateway.DeleteApiConfigRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'ApiGatewayServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py new file mode 100644 index 0000000..6902f5d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py @@ -0,0 +1,638 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.apigateway_v1.types import apigateway +from google.longrunning import operations_pb2 # type: ignore +from .base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO + + +class ApiGatewayServiceGrpcTransport(ApiGatewayServiceTransport): + """gRPC backend transport for ApiGatewayService. + + The API Gateway Service is the interface for managing API + Gateways. + + 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 = 'apigateway.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'apigateway.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_gateways(self) -> Callable[ + [apigateway.ListGatewaysRequest], + apigateway.ListGatewaysResponse]: + r"""Return a callable for the list gateways method over gRPC. + + Lists Gateways in a given project and location. + + Returns: + Callable[[~.ListGatewaysRequest], + ~.ListGatewaysResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_gateways' not in self._stubs: + self._stubs['list_gateways'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListGateways', + request_serializer=apigateway.ListGatewaysRequest.serialize, + response_deserializer=apigateway.ListGatewaysResponse.deserialize, + ) + return self._stubs['list_gateways'] + + @property + def get_gateway(self) -> Callable[ + [apigateway.GetGatewayRequest], + apigateway.Gateway]: + r"""Return a callable for the get gateway method over gRPC. + + Gets details of a single Gateway. + + Returns: + Callable[[~.GetGatewayRequest], + ~.Gateway]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_gateway' not in self._stubs: + self._stubs['get_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetGateway', + request_serializer=apigateway.GetGatewayRequest.serialize, + response_deserializer=apigateway.Gateway.deserialize, + ) + return self._stubs['get_gateway'] + + @property + def create_gateway(self) -> Callable[ + [apigateway.CreateGatewayRequest], + operations_pb2.Operation]: + r"""Return a callable for the create gateway method over gRPC. + + Creates a new Gateway in a given project and + location. + + Returns: + Callable[[~.CreateGatewayRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_gateway' not in self._stubs: + self._stubs['create_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway', + request_serializer=apigateway.CreateGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_gateway'] + + @property + def update_gateway(self) -> Callable[ + [apigateway.UpdateGatewayRequest], + operations_pb2.Operation]: + r"""Return a callable for the update gateway method over gRPC. + + Updates the parameters of a single Gateway. + + Returns: + Callable[[~.UpdateGatewayRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_gateway' not in self._stubs: + self._stubs['update_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway', + request_serializer=apigateway.UpdateGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_gateway'] + + @property + def delete_gateway(self) -> Callable[ + [apigateway.DeleteGatewayRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete gateway method over gRPC. + + Deletes a single Gateway. + + Returns: + Callable[[~.DeleteGatewayRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_gateway' not in self._stubs: + self._stubs['delete_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway', + request_serializer=apigateway.DeleteGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_gateway'] + + @property + def list_apis(self) -> Callable[ + [apigateway.ListApisRequest], + apigateway.ListApisResponse]: + r"""Return a callable for the list apis method over gRPC. + + Lists Apis in a given project and location. + + Returns: + Callable[[~.ListApisRequest], + ~.ListApisResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_apis' not in self._stubs: + self._stubs['list_apis'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListApis', + request_serializer=apigateway.ListApisRequest.serialize, + response_deserializer=apigateway.ListApisResponse.deserialize, + ) + return self._stubs['list_apis'] + + @property + def get_api(self) -> Callable[ + [apigateway.GetApiRequest], + apigateway.Api]: + r"""Return a callable for the get api method over gRPC. + + Gets details of a single Api. + + Returns: + Callable[[~.GetApiRequest], + ~.Api]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_api' not in self._stubs: + self._stubs['get_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetApi', + request_serializer=apigateway.GetApiRequest.serialize, + response_deserializer=apigateway.Api.deserialize, + ) + return self._stubs['get_api'] + + @property + def create_api(self) -> Callable[ + [apigateway.CreateApiRequest], + operations_pb2.Operation]: + r"""Return a callable for the create api method over gRPC. + + Creates a new Api in a given project and location. + + Returns: + Callable[[~.CreateApiRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_api' not in self._stubs: + self._stubs['create_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateApi', + request_serializer=apigateway.CreateApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_api'] + + @property + def update_api(self) -> Callable[ + [apigateway.UpdateApiRequest], + operations_pb2.Operation]: + r"""Return a callable for the update api method over gRPC. + + Updates the parameters of a single Api. + + Returns: + Callable[[~.UpdateApiRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_api' not in self._stubs: + self._stubs['update_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi', + request_serializer=apigateway.UpdateApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_api'] + + @property + def delete_api(self) -> Callable[ + [apigateway.DeleteApiRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete api method over gRPC. + + Deletes a single Api. + + Returns: + Callable[[~.DeleteApiRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_api' not in self._stubs: + self._stubs['delete_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi', + request_serializer=apigateway.DeleteApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_api'] + + @property + def list_api_configs(self) -> Callable[ + [apigateway.ListApiConfigsRequest], + apigateway.ListApiConfigsResponse]: + r"""Return a callable for the list api configs method over gRPC. + + Lists ApiConfigs in a given project and location. + + Returns: + Callable[[~.ListApiConfigsRequest], + ~.ListApiConfigsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_api_configs' not in self._stubs: + self._stubs['list_api_configs'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs', + request_serializer=apigateway.ListApiConfigsRequest.serialize, + response_deserializer=apigateway.ListApiConfigsResponse.deserialize, + ) + return self._stubs['list_api_configs'] + + @property + def get_api_config(self) -> Callable[ + [apigateway.GetApiConfigRequest], + apigateway.ApiConfig]: + r"""Return a callable for the get api config method over gRPC. + + Gets details of a single ApiConfig. + + Returns: + Callable[[~.GetApiConfigRequest], + ~.ApiConfig]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_api_config' not in self._stubs: + self._stubs['get_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig', + request_serializer=apigateway.GetApiConfigRequest.serialize, + response_deserializer=apigateway.ApiConfig.deserialize, + ) + return self._stubs['get_api_config'] + + @property + def create_api_config(self) -> Callable[ + [apigateway.CreateApiConfigRequest], + operations_pb2.Operation]: + r"""Return a callable for the create api config method over gRPC. + + Creates a new ApiConfig in a given project and + location. + + Returns: + Callable[[~.CreateApiConfigRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_api_config' not in self._stubs: + self._stubs['create_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig', + request_serializer=apigateway.CreateApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_api_config'] + + @property + def update_api_config(self) -> Callable[ + [apigateway.UpdateApiConfigRequest], + operations_pb2.Operation]: + r"""Return a callable for the update api config method over gRPC. + + Updates the parameters of a single ApiConfig. + + Returns: + Callable[[~.UpdateApiConfigRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_api_config' not in self._stubs: + self._stubs['update_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig', + request_serializer=apigateway.UpdateApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_api_config'] + + @property + def delete_api_config(self) -> Callable[ + [apigateway.DeleteApiConfigRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete api config method over gRPC. + + Deletes a single ApiConfig. + + Returns: + Callable[[~.DeleteApiConfigRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_api_config' not in self._stubs: + self._stubs['delete_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig', + request_serializer=apigateway.DeleteApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_api_config'] + + +__all__ = ( + 'ApiGatewayServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..7d067dd --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py @@ -0,0 +1,642 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.apigateway_v1.types import apigateway +from google.longrunning import operations_pb2 # type: ignore +from .base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import ApiGatewayServiceGrpcTransport + + +class ApiGatewayServiceGrpcAsyncIOTransport(ApiGatewayServiceTransport): + """gRPC AsyncIO backend transport for ApiGatewayService. + + The API Gateway Service is the interface for managing API + Gateways. + + 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 = 'apigateway.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'apigateway.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_gateways(self) -> Callable[ + [apigateway.ListGatewaysRequest], + Awaitable[apigateway.ListGatewaysResponse]]: + r"""Return a callable for the list gateways method over gRPC. + + Lists Gateways in a given project and location. + + Returns: + Callable[[~.ListGatewaysRequest], + Awaitable[~.ListGatewaysResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_gateways' not in self._stubs: + self._stubs['list_gateways'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListGateways', + request_serializer=apigateway.ListGatewaysRequest.serialize, + response_deserializer=apigateway.ListGatewaysResponse.deserialize, + ) + return self._stubs['list_gateways'] + + @property + def get_gateway(self) -> Callable[ + [apigateway.GetGatewayRequest], + Awaitable[apigateway.Gateway]]: + r"""Return a callable for the get gateway method over gRPC. + + Gets details of a single Gateway. + + Returns: + Callable[[~.GetGatewayRequest], + Awaitable[~.Gateway]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_gateway' not in self._stubs: + self._stubs['get_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetGateway', + request_serializer=apigateway.GetGatewayRequest.serialize, + response_deserializer=apigateway.Gateway.deserialize, + ) + return self._stubs['get_gateway'] + + @property + def create_gateway(self) -> Callable[ + [apigateway.CreateGatewayRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create gateway method over gRPC. + + Creates a new Gateway in a given project and + location. + + Returns: + Callable[[~.CreateGatewayRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_gateway' not in self._stubs: + self._stubs['create_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway', + request_serializer=apigateway.CreateGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_gateway'] + + @property + def update_gateway(self) -> Callable[ + [apigateway.UpdateGatewayRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update gateway method over gRPC. + + Updates the parameters of a single Gateway. + + Returns: + Callable[[~.UpdateGatewayRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_gateway' not in self._stubs: + self._stubs['update_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway', + request_serializer=apigateway.UpdateGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_gateway'] + + @property + def delete_gateway(self) -> Callable[ + [apigateway.DeleteGatewayRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete gateway method over gRPC. + + Deletes a single Gateway. + + Returns: + Callable[[~.DeleteGatewayRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_gateway' not in self._stubs: + self._stubs['delete_gateway'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway', + request_serializer=apigateway.DeleteGatewayRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_gateway'] + + @property + def list_apis(self) -> Callable[ + [apigateway.ListApisRequest], + Awaitable[apigateway.ListApisResponse]]: + r"""Return a callable for the list apis method over gRPC. + + Lists Apis in a given project and location. + + Returns: + Callable[[~.ListApisRequest], + Awaitable[~.ListApisResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_apis' not in self._stubs: + self._stubs['list_apis'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListApis', + request_serializer=apigateway.ListApisRequest.serialize, + response_deserializer=apigateway.ListApisResponse.deserialize, + ) + return self._stubs['list_apis'] + + @property + def get_api(self) -> Callable[ + [apigateway.GetApiRequest], + Awaitable[apigateway.Api]]: + r"""Return a callable for the get api method over gRPC. + + Gets details of a single Api. + + Returns: + Callable[[~.GetApiRequest], + Awaitable[~.Api]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_api' not in self._stubs: + self._stubs['get_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetApi', + request_serializer=apigateway.GetApiRequest.serialize, + response_deserializer=apigateway.Api.deserialize, + ) + return self._stubs['get_api'] + + @property + def create_api(self) -> Callable[ + [apigateway.CreateApiRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create api method over gRPC. + + Creates a new Api in a given project and location. + + Returns: + Callable[[~.CreateApiRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_api' not in self._stubs: + self._stubs['create_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateApi', + request_serializer=apigateway.CreateApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_api'] + + @property + def update_api(self) -> Callable[ + [apigateway.UpdateApiRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update api method over gRPC. + + Updates the parameters of a single Api. + + Returns: + Callable[[~.UpdateApiRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_api' not in self._stubs: + self._stubs['update_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi', + request_serializer=apigateway.UpdateApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_api'] + + @property + def delete_api(self) -> Callable[ + [apigateway.DeleteApiRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete api method over gRPC. + + Deletes a single Api. + + Returns: + Callable[[~.DeleteApiRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_api' not in self._stubs: + self._stubs['delete_api'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi', + request_serializer=apigateway.DeleteApiRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_api'] + + @property + def list_api_configs(self) -> Callable[ + [apigateway.ListApiConfigsRequest], + Awaitable[apigateway.ListApiConfigsResponse]]: + r"""Return a callable for the list api configs method over gRPC. + + Lists ApiConfigs in a given project and location. + + Returns: + Callable[[~.ListApiConfigsRequest], + Awaitable[~.ListApiConfigsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_api_configs' not in self._stubs: + self._stubs['list_api_configs'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs', + request_serializer=apigateway.ListApiConfigsRequest.serialize, + response_deserializer=apigateway.ListApiConfigsResponse.deserialize, + ) + return self._stubs['list_api_configs'] + + @property + def get_api_config(self) -> Callable[ + [apigateway.GetApiConfigRequest], + Awaitable[apigateway.ApiConfig]]: + r"""Return a callable for the get api config method over gRPC. + + Gets details of a single ApiConfig. + + Returns: + Callable[[~.GetApiConfigRequest], + Awaitable[~.ApiConfig]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_api_config' not in self._stubs: + self._stubs['get_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig', + request_serializer=apigateway.GetApiConfigRequest.serialize, + response_deserializer=apigateway.ApiConfig.deserialize, + ) + return self._stubs['get_api_config'] + + @property + def create_api_config(self) -> Callable[ + [apigateway.CreateApiConfigRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create api config method over gRPC. + + Creates a new ApiConfig in a given project and + location. + + Returns: + Callable[[~.CreateApiConfigRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_api_config' not in self._stubs: + self._stubs['create_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig', + request_serializer=apigateway.CreateApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_api_config'] + + @property + def update_api_config(self) -> Callable[ + [apigateway.UpdateApiConfigRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update api config method over gRPC. + + Updates the parameters of a single ApiConfig. + + Returns: + Callable[[~.UpdateApiConfigRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_api_config' not in self._stubs: + self._stubs['update_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig', + request_serializer=apigateway.UpdateApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_api_config'] + + @property + def delete_api_config(self) -> Callable[ + [apigateway.DeleteApiConfigRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete api config method over gRPC. + + Deletes a single ApiConfig. + + Returns: + Callable[[~.DeleteApiConfigRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_api_config' not in self._stubs: + self._stubs['delete_api_config'] = self.grpc_channel.unary_unary( + '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig', + request_serializer=apigateway.DeleteApiConfigRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_api_config'] + + +__all__ = ( + 'ApiGatewayServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py new file mode 100644 index 0000000..d11ff3a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .apigateway import ( + Api, + ApiConfig, + CreateApiConfigRequest, + CreateApiRequest, + CreateGatewayRequest, + DeleteApiConfigRequest, + DeleteApiRequest, + DeleteGatewayRequest, + Gateway, + GetApiConfigRequest, + GetApiRequest, + GetGatewayRequest, + ListApiConfigsRequest, + ListApiConfigsResponse, + ListApisRequest, + ListApisResponse, + ListGatewaysRequest, + ListGatewaysResponse, + OperationMetadata, + UpdateApiConfigRequest, + UpdateApiRequest, + UpdateGatewayRequest, +) + +__all__ = ( + 'Api', + 'ApiConfig', + 'CreateApiConfigRequest', + 'CreateApiRequest', + 'CreateGatewayRequest', + 'DeleteApiConfigRequest', + 'DeleteApiRequest', + 'DeleteGatewayRequest', + 'Gateway', + 'GetApiConfigRequest', + 'GetApiRequest', + 'GetGatewayRequest', + 'ListApiConfigsRequest', + 'ListApiConfigsResponse', + 'ListApisRequest', + 'ListApisResponse', + 'ListGatewaysRequest', + 'ListGatewaysResponse', + 'OperationMetadata', + 'UpdateApiConfigRequest', + 'UpdateApiRequest', + 'UpdateGatewayRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py new file mode 100644 index 0000000..5f82895 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py @@ -0,0 +1,941 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.apigateway.v1', + manifest={ + 'Api', + 'ApiConfig', + 'Gateway', + 'ListGatewaysRequest', + 'ListGatewaysResponse', + 'GetGatewayRequest', + 'CreateGatewayRequest', + 'UpdateGatewayRequest', + 'DeleteGatewayRequest', + 'ListApisRequest', + 'ListApisResponse', + 'GetApiRequest', + 'CreateApiRequest', + 'UpdateApiRequest', + 'DeleteApiRequest', + 'ListApiConfigsRequest', + 'ListApiConfigsResponse', + 'GetApiConfigRequest', + 'CreateApiConfigRequest', + 'UpdateApiConfigRequest', + 'DeleteApiConfigRequest', + 'OperationMetadata', + }, +) + + +class Api(proto.Message): + r"""An API that can be served by one or more Gateways. + Attributes: + name (str): + Output only. Resource name of the API. + Format: + projects/{project}/locations/global/apis/{api} + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Created time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Updated time. + labels (Sequence[google.cloud.apigateway_v1.types.Api.LabelsEntry]): + Optional. Resource labels to represent user- + rovided metadata. Refer to cloud documentation + on labels for more details. + https://cloud.google.com/compute/docs/labeling- + resources + display_name (str): + Optional. Display name. + managed_service (str): + Optional. Immutable. The name of a Google + Managed Service ( + https://cloud.google.com/service- + infrastructure/docs/glossary#managed). If not + specified, a new Service will automatically be + created in the same project as this API. + state (google.cloud.apigateway_v1.types.Api.State): + Output only. State of the API. + """ + class State(proto.Enum): + r"""All the possible API states.""" + STATE_UNSPECIFIED = 0 + CREATING = 1 + ACTIVE = 2 + FAILED = 3 + DELETING = 4 + UPDATING = 5 + + name = proto.Field( + proto.STRING, + number=1, + ) + create_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=4, + ) + display_name = proto.Field( + proto.STRING, + number=5, + ) + managed_service = proto.Field( + proto.STRING, + number=7, + ) + state = proto.Field( + proto.ENUM, + number=12, + enum=State, + ) + + +class ApiConfig(proto.Message): + r"""An API Configuration is a combination of settings for both + the Managed Service and Gateways serving this API Config. + + Attributes: + name (str): + Output only. Resource name of the API Config. Format: + projects/{project}/locations/global/apis/{api}/configs/{api_config} + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Created time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Updated time. + labels (Sequence[google.cloud.apigateway_v1.types.ApiConfig.LabelsEntry]): + Optional. Resource labels to represent user- + rovided metadata. Refer to cloud documentation + on labels for more details. + https://cloud.google.com/compute/docs/labeling- + resources + display_name (str): + Optional. Display name. + gateway_service_account (str): + Immutable. The Google Cloud IAM Service Account that + Gateways serving this config should use to authenticate to + other services. This may either be the Service Account's + email (``{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com``) + or its full resource name + (``projects/{PROJECT}/accounts/{UNIQUE_ID}``). This is most + often used when the service is a GCP resource such as a + Cloud Run Service or an IAP-secured service. + service_config_id (str): + Output only. The ID of the associated Service + Config ( https://cloud.google.com/service- + infrastructure/docs/glossary#config). + state (google.cloud.apigateway_v1.types.ApiConfig.State): + Output only. State of the API Config. + openapi_documents (Sequence[google.cloud.apigateway_v1.types.ApiConfig.OpenApiDocument]): + Optional. OpenAPI specification documents. If specified, + grpc_services and managed_service_configs must not be + included. + grpc_services (Sequence[google.cloud.apigateway_v1.types.ApiConfig.GrpcServiceDefinition]): + Optional. gRPC service definition files. If specified, + openapi_documents must not be included. + managed_service_configs (Sequence[google.cloud.apigateway_v1.types.ApiConfig.File]): + Optional. Service Configuration files. At least one must be + included when using gRPC service definitions. See + https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview + for the expected file contents. + + If multiple files are specified, the files are merged with + the following rules: + + - All singular scalar fields are merged using "last one + wins" semantics in the order of the files uploaded. + - Repeated fields are concatenated. + - Singular embedded messages are merged using these rules + for nested fields. + """ + class State(proto.Enum): + r"""All the possible API Config states.""" + STATE_UNSPECIFIED = 0 + CREATING = 1 + ACTIVE = 2 + FAILED = 3 + DELETING = 4 + UPDATING = 5 + ACTIVATING = 6 + + class File(proto.Message): + r"""A lightweight description of a file. + Attributes: + path (str): + The file path (full or relative path). This + is typically the path of the file when it is + uploaded. + contents (bytes): + The bytes that constitute the file. + """ + + path = proto.Field( + proto.STRING, + number=1, + ) + contents = proto.Field( + proto.BYTES, + number=2, + ) + + class OpenApiDocument(proto.Message): + r"""An OpenAPI Specification Document describing an API. + Attributes: + document (google.cloud.apigateway_v1.types.ApiConfig.File): + The OpenAPI Specification document file. + """ + + document = proto.Field( + proto.MESSAGE, + number=1, + message='ApiConfig.File', + ) + + class GrpcServiceDefinition(proto.Message): + r"""A gRPC service definition. + Attributes: + file_descriptor_set (google.cloud.apigateway_v1.types.ApiConfig.File): + Input only. File descriptor set, generated by protoc. + + To generate, use protoc with imports and source info + included. For an example test.proto file, the following + command would put the value in a new file named out.pb. + + $ protoc --include_imports --include_source_info test.proto + -o out.pb + source (Sequence[google.cloud.apigateway_v1.types.ApiConfig.File]): + Optional. Uncompiled proto files associated with the + descriptor set, used for display purposes (server-side + compilation is not supported). These should match the inputs + to 'protoc' command used to generate file_descriptor_set. + """ + + file_descriptor_set = proto.Field( + proto.MESSAGE, + number=1, + message='ApiConfig.File', + ) + source = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='ApiConfig.File', + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + create_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=4, + ) + display_name = proto.Field( + proto.STRING, + number=5, + ) + gateway_service_account = proto.Field( + proto.STRING, + number=14, + ) + service_config_id = proto.Field( + proto.STRING, + number=12, + ) + state = proto.Field( + proto.ENUM, + number=8, + enum=State, + ) + openapi_documents = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=OpenApiDocument, + ) + grpc_services = proto.RepeatedField( + proto.MESSAGE, + number=10, + message=GrpcServiceDefinition, + ) + managed_service_configs = proto.RepeatedField( + proto.MESSAGE, + number=11, + message=File, + ) + + +class Gateway(proto.Message): + r"""A Gateway is an API-aware HTTP proxy. It performs API-Method + and/or API-Consumer specific actions based on an API Config such + as authentication, policy enforcement, and backend selection. + + Attributes: + name (str): + Output only. Resource name of the Gateway. + Format: + projects/{project}/locations/{location}/gateways/{gateway} + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Created time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Updated time. + labels (Sequence[google.cloud.apigateway_v1.types.Gateway.LabelsEntry]): + Optional. Resource labels to represent user- + rovided metadata. Refer to cloud documentation + on labels for more details. + https://cloud.google.com/compute/docs/labeling- + resources + display_name (str): + Optional. Display name. + api_config (str): + Required. Resource name of the API Config for + this Gateway. Format: + projects/{project}/locations/global/apis/{api}/configs/{apiConfig} + state (google.cloud.apigateway_v1.types.Gateway.State): + Output only. The current state of the + Gateway. + default_hostname (str): + Output only. The default API Gateway host name of the form + ``{gateway_id}-{hash}.{region_code}.gateway.dev``. + """ + class State(proto.Enum): + r"""All the possible Gateway states.""" + STATE_UNSPECIFIED = 0 + CREATING = 1 + ACTIVE = 2 + FAILED = 3 + DELETING = 4 + UPDATING = 5 + + name = proto.Field( + proto.STRING, + number=1, + ) + create_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=4, + ) + display_name = proto.Field( + proto.STRING, + number=5, + ) + api_config = proto.Field( + proto.STRING, + number=6, + ) + state = proto.Field( + proto.ENUM, + number=7, + enum=State, + ) + default_hostname = proto.Field( + proto.STRING, + number=9, + ) + + +class ListGatewaysRequest(proto.Message): + r"""Request message for ApiGatewayService.ListGateways + Attributes: + parent (str): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + page_size (int): + Page size. + page_token (str): + Page token. + filter (str): + Filter. + order_by (str): + Order by parameters. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + order_by = proto.Field( + proto.STRING, + number=5, + ) + + +class ListGatewaysResponse(proto.Message): + r"""Response message for ApiGatewayService.ListGateways + Attributes: + gateways (Sequence[google.cloud.apigateway_v1.types.Gateway]): + Gateways. + next_page_token (str): + Next page token. + unreachable_locations (Sequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + gateways = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Gateway', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + unreachable_locations = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetGatewayRequest(proto.Message): + r"""Request message for ApiGatewayService.GetGateway + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateGatewayRequest(proto.Message): + r"""Request message for ApiGatewayService.CreateGateway + Attributes: + parent (str): + Required. Parent resource of the Gateway, of the form: + ``projects/*/locations/*`` + gateway_id (str): + Required. Identifier to assign to the + Gateway. Must be unique within scope of the + parent resource. + gateway (google.cloud.apigateway_v1.types.Gateway): + Required. Gateway resource. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + gateway_id = proto.Field( + proto.STRING, + number=2, + ) + gateway = proto.Field( + proto.MESSAGE, + number=3, + message='Gateway', + ) + + +class UpdateGatewayRequest(proto.Message): + r"""Request message for ApiGatewayService.UpdateGateway + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be overwritten + in the Gateway resource by the update. The fields specified + in the update_mask are relative to the resource, not the + full request. A field will be overwritten if it is in the + mask. If the user does not provide a mask then all fields + will be overwritten. + gateway (google.cloud.apigateway_v1.types.Gateway): + Required. Gateway resource. + """ + + update_mask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + gateway = proto.Field( + proto.MESSAGE, + number=2, + message='Gateway', + ) + + +class DeleteGatewayRequest(proto.Message): + r"""Request message for ApiGatewayService.DeleteGateway + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/*/gateways/*`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class ListApisRequest(proto.Message): + r"""Request message for ApiGatewayService.ListApis + Attributes: + parent (str): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + page_size (int): + Page size. + page_token (str): + Page token. + filter (str): + Filter. + order_by (str): + Order by parameters. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + order_by = proto.Field( + proto.STRING, + number=5, + ) + + +class ListApisResponse(proto.Message): + r"""Response message for ApiGatewayService.ListApis + Attributes: + apis (Sequence[google.cloud.apigateway_v1.types.Api]): + APIs. + next_page_token (str): + Next page token. + unreachable_locations (Sequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + apis = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Api', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + unreachable_locations = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetApiRequest(proto.Message): + r"""Request message for ApiGatewayService.GetApi + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateApiRequest(proto.Message): + r"""Request message for ApiGatewayService.CreateApi + Attributes: + parent (str): + Required. Parent resource of the API, of the form: + ``projects/*/locations/global`` + api_id (str): + Required. Identifier to assign to the API. + Must be unique within scope of the parent + resource. + api (google.cloud.apigateway_v1.types.Api): + Required. API resource. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + api_id = proto.Field( + proto.STRING, + number=2, + ) + api = proto.Field( + proto.MESSAGE, + number=3, + message='Api', + ) + + +class UpdateApiRequest(proto.Message): + r"""Request message for ApiGatewayService.UpdateApi + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be overwritten + in the Api resource by the update. The fields specified in + the update_mask are relative to the resource, not the full + request. A field will be overwritten if it is in the mask. + If the user does not provide a mask then all fields will be + overwritten. + api (google.cloud.apigateway_v1.types.Api): + Required. API resource. + """ + + update_mask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + api = proto.Field( + proto.MESSAGE, + number=2, + message='Api', + ) + + +class DeleteApiRequest(proto.Message): + r"""Request message for ApiGatewayService.DeleteApi + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class ListApiConfigsRequest(proto.Message): + r"""Request message for ApiGatewayService.ListApiConfigs + Attributes: + parent (str): + Required. Parent resource of the API Config, of the form: + ``projects/*/locations/global/apis/*`` + page_size (int): + Page size. + page_token (str): + Page token. + filter (str): + Filter. + order_by (str): + Order by parameters. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + filter = proto.Field( + proto.STRING, + number=4, + ) + order_by = proto.Field( + proto.STRING, + number=5, + ) + + +class ListApiConfigsResponse(proto.Message): + r"""Response message for ApiGatewayService.ListApiConfigs + Attributes: + api_configs (Sequence[google.cloud.apigateway_v1.types.ApiConfig]): + API Configs. + next_page_token (str): + Next page token. + unreachable_locations (Sequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + api_configs = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='ApiConfig', + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + unreachable_locations = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetApiConfigRequest(proto.Message): + r"""Request message for ApiGatewayService.GetApiConfig + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + view (google.cloud.apigateway_v1.types.GetApiConfigRequest.ConfigView): + Specifies which fields of the API Config are returned in the + response. Defaults to ``BASIC`` view. + """ + class ConfigView(proto.Enum): + r"""Enum to control which fields should be included in the + response. + """ + CONFIG_VIEW_UNSPECIFIED = 0 + BASIC = 1 + FULL = 2 + + name = proto.Field( + proto.STRING, + number=1, + ) + view = proto.Field( + proto.ENUM, + number=3, + enum=ConfigView, + ) + + +class CreateApiConfigRequest(proto.Message): + r"""Request message for ApiGatewayService.CreateApiConfig + Attributes: + parent (str): + Required. Parent resource of the API Config, of the form: + ``projects/*/locations/global/apis/*`` + api_config_id (str): + Required. Identifier to assign to the API + Config. Must be unique within scope of the + parent resource. + api_config (google.cloud.apigateway_v1.types.ApiConfig): + Required. API resource. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + api_config_id = proto.Field( + proto.STRING, + number=2, + ) + api_config = proto.Field( + proto.MESSAGE, + number=3, + message='ApiConfig', + ) + + +class UpdateApiConfigRequest(proto.Message): + r"""Request message for ApiGatewayService.UpdateApiConfig + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Field mask is used to specify the fields to be overwritten + in the ApiConfig resource by the update. The fields + specified in the update_mask are relative to the resource, + not the full request. A field will be overwritten if it is + in the mask. If the user does not provide a mask then all + fields will be overwritten. + api_config (google.cloud.apigateway_v1.types.ApiConfig): + Required. API Config resource. + """ + + update_mask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + api_config = proto.Field( + proto.MESSAGE, + number=2, + message='ApiConfig', + ) + + +class DeleteApiConfigRequest(proto.Message): + r"""Request message for ApiGatewayService.DeleteApiConfig + Attributes: + name (str): + Required. Resource name of the form: + ``projects/*/locations/global/apis/*/configs/*`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of the long-running operation. + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the operation was + created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the operation finished + running. + target (str): + Output only. Server-defined resource path for + the target of the operation. + verb (str): + Output only. Name of the verb executed by the + operation. + status_message (str): + Output only. Human-readable status of the + operation, if any. + requested_cancellation (bool): + Output only. Identifies whether the user has requested + cancellation of the operation. Operations that have + successfully been cancelled have [Operation.error][] value + with a [google.rpc.Status.code][google.rpc.Status.code] of + 1, corresponding to ``Code.CANCELLED``. + api_version (str): + Output only. API version used to start the + operation. + diagnostics (Sequence[google.cloud.apigateway_v1.types.OperationMetadata.Diagnostic]): + Output only. Diagnostics generated during + processing of configuration source files. + """ + + class Diagnostic(proto.Message): + r"""Diagnostic information from configuration processing. + Attributes: + location (str): + Location of the diagnostic. + message (str): + The diagnostic message. + """ + + location = proto.Field( + proto.STRING, + number=1, + ) + message = proto.Field( + proto.STRING, + number=2, + ) + + create_time = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target = proto.Field( + proto.STRING, + number=3, + ) + verb = proto.Field( + proto.STRING, + number=4, + ) + status_message = proto.Field( + proto.STRING, + number=5, + ) + requested_cancellation = proto.Field( + proto.BOOL, + number=6, + ) + api_version = proto.Field( + proto.STRING, + number=7, + ) + diagnostics = proto.RepeatedField( + proto.MESSAGE, + number=8, + message=Diagnostic, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py new file mode 100644 index 0000000..958c7e3 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + + +__protobuf__ = proto.module( + package='google.cloud.apigateway.v1', + manifest={ + }, +) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..8d6ee10 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/apigateway_v1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py new file mode 100644 index 0000000..893aa60 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py @@ -0,0 +1,190 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class apigatewayCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_api': ('parent', 'api_id', 'api', ), + 'create_api_config': ('parent', 'api_config_id', 'api_config', ), + 'create_gateway': ('parent', 'gateway_id', 'gateway', ), + 'delete_api': ('name', ), + 'delete_api_config': ('name', ), + 'delete_gateway': ('name', ), + 'get_api': ('name', ), + 'get_api_config': ('name', 'view', ), + 'get_gateway': ('name', ), + 'list_api_configs': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_apis': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_gateways': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'update_api': ('api', 'update_mask', ), + 'update_api_config': ('api_config', 'update_mask', ), + 'update_gateway': ('gateway', 'update_mask', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: not a.keyword.value in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=apigatewayCallTransformer(), +): + """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 apigateway client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..06369e4 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-api-gateway', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py new file mode 100644 index 0000000..69244be --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py @@ -0,0 +1,5205 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.apigateway_v1.services.api_gateway_service import ApiGatewayServiceAsyncClient +from google.cloud.apigateway_v1.services.api_gateway_service import ApiGatewayServiceClient +from google.cloud.apigateway_v1.services.api_gateway_service import pagers +from google.cloud.apigateway_v1.services.api_gateway_service import transports +from google.cloud.apigateway_v1.services.api_gateway_service.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.apigateway_v1.types import apigateway +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert ApiGatewayServiceClient._get_default_mtls_endpoint(None) is None + assert ApiGatewayServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert ApiGatewayServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert ApiGatewayServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert ApiGatewayServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert ApiGatewayServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + ApiGatewayServiceClient, + ApiGatewayServiceAsyncClient, +]) +def test_api_gateway_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'apigateway.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.ApiGatewayServiceGrpcTransport, "grpc"), + (transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_api_gateway_service_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", [ + ApiGatewayServiceClient, + ApiGatewayServiceAsyncClient, +]) +def test_api_gateway_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'apigateway.googleapis.com:443' + + +def test_api_gateway_service_client_get_transport_class(): + transport = ApiGatewayServiceClient.get_transport_class() + available_transports = [ + transports.ApiGatewayServiceGrpcTransport, + ] + assert transport in available_transports + + transport = ApiGatewayServiceClient.get_transport_class("grpc") + assert transport == transports.ApiGatewayServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), + (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(ApiGatewayServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceClient)) +@mock.patch.object(ApiGatewayServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceAsyncClient)) +def test_api_gateway_service_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(ApiGatewayServiceClient, '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(ApiGatewayServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc", "true"), + (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc", "false"), + (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(ApiGatewayServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceClient)) +@mock.patch.object(ApiGatewayServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_api_gateway_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), + (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_api_gateway_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), + (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_api_gateway_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_api_gateway_service_client_client_options_from_dict(): + with mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = ApiGatewayServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_list_gateways(transport: str = 'grpc', request_type=apigateway.ListGatewaysRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListGatewaysResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + ) + response = client.list_gateways(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListGatewaysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListGatewaysPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +def test_list_gateways_from_dict(): + test_list_gateways(request_type=dict) + + +def test_list_gateways_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + client.list_gateways() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListGatewaysRequest() + + +@pytest.mark.asyncio +async def test_list_gateways_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListGatewaysRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + )) + response = await client.list_gateways(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListGatewaysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListGatewaysAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +@pytest.mark.asyncio +async def test_list_gateways_async_from_dict(): + await test_list_gateways_async(request_type=dict) + + +def test_list_gateways_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.ListGatewaysRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + call.return_value = apigateway.ListGatewaysResponse() + client.list_gateways(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_gateways_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.ListGatewaysRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse()) + await client.list_gateways(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_list_gateways_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListGatewaysResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_gateways( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_gateways_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_gateways( + apigateway.ListGatewaysRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_gateways_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListGatewaysResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_gateways( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_gateways_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_gateways( + apigateway.ListGatewaysRequest(), + parent='parent_value', + ) + + +def test_list_gateways_pager(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + apigateway.Gateway(), + ], + next_page_token='abc', + ), + apigateway.ListGatewaysResponse( + gateways=[], + next_page_token='def', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + ], + next_page_token='ghi', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_gateways(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, apigateway.Gateway) + for i in results) + +def test_list_gateways_pages(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + apigateway.Gateway(), + ], + next_page_token='abc', + ), + apigateway.ListGatewaysResponse( + gateways=[], + next_page_token='def', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + ], + next_page_token='ghi', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + ], + ), + RuntimeError, + ) + pages = list(client.list_gateways(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_gateways_async_pager(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + apigateway.Gateway(), + ], + next_page_token='abc', + ), + apigateway.ListGatewaysResponse( + gateways=[], + next_page_token='def', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + ], + next_page_token='ghi', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_gateways(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, apigateway.Gateway) + for i in responses) + +@pytest.mark.asyncio +async def test_list_gateways_async_pages(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_gateways), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + apigateway.Gateway(), + ], + next_page_token='abc', + ), + apigateway.ListGatewaysResponse( + gateways=[], + next_page_token='def', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + ], + next_page_token='ghi', + ), + apigateway.ListGatewaysResponse( + gateways=[ + apigateway.Gateway(), + apigateway.Gateway(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_gateways(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_gateway(transport: str = 'grpc', request_type=apigateway.GetGatewayRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Gateway( + name='name_value', + display_name='display_name_value', + api_config='api_config_value', + state=apigateway.Gateway.State.CREATING, + default_hostname='default_hostname_value', + ) + response = client.get_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.Gateway) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.api_config == 'api_config_value' + assert response.state == apigateway.Gateway.State.CREATING + assert response.default_hostname == 'default_hostname_value' + + +def test_get_gateway_from_dict(): + test_get_gateway(request_type=dict) + + +def test_get_gateway_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + client.get_gateway() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetGatewayRequest() + + +@pytest.mark.asyncio +async def test_get_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetGatewayRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway( + name='name_value', + display_name='display_name_value', + api_config='api_config_value', + state=apigateway.Gateway.State.CREATING, + default_hostname='default_hostname_value', + )) + response = await client.get_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.Gateway) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.api_config == 'api_config_value' + assert response.state == apigateway.Gateway.State.CREATING + assert response.default_hostname == 'default_hostname_value' + + +@pytest.mark.asyncio +async def test_get_gateway_async_from_dict(): + await test_get_gateway_async(request_type=dict) + + +def test_get_gateway_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.GetGatewayRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + call.return_value = apigateway.Gateway() + client.get_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_gateway_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.GetGatewayRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway()) + await client.get_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_get_gateway_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Gateway() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_gateway( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_gateway_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_gateway( + apigateway.GetGatewayRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_gateway_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Gateway() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_gateway( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_gateway_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_gateway( + apigateway.GetGatewayRequest(), + name='name_value', + ) + + +def test_create_gateway(transport: str = 'grpc', request_type=apigateway.CreateGatewayRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_gateway_from_dict(): + test_create_gateway(request_type=dict) + + +def test_create_gateway_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + client.create_gateway() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateGatewayRequest() + + +@pytest.mark.asyncio +async def test_create_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateGatewayRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_gateway_async_from_dict(): + await test_create_gateway_async(request_type=dict) + + +def test_create_gateway_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.CreateGatewayRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_gateway_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.CreateGatewayRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_create_gateway_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_gateway( + parent='parent_value', + gateway=apigateway.Gateway(name='name_value'), + gateway_id='gateway_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].gateway == apigateway.Gateway(name='name_value') + assert args[0].gateway_id == 'gateway_id_value' + + +def test_create_gateway_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_gateway( + apigateway.CreateGatewayRequest(), + parent='parent_value', + gateway=apigateway.Gateway(name='name_value'), + gateway_id='gateway_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_gateway_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_gateway( + parent='parent_value', + gateway=apigateway.Gateway(name='name_value'), + gateway_id='gateway_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].gateway == apigateway.Gateway(name='name_value') + assert args[0].gateway_id == 'gateway_id_value' + + +@pytest.mark.asyncio +async def test_create_gateway_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_gateway( + apigateway.CreateGatewayRequest(), + parent='parent_value', + gateway=apigateway.Gateway(name='name_value'), + gateway_id='gateway_id_value', + ) + + +def test_update_gateway(transport: str = 'grpc', request_type=apigateway.UpdateGatewayRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_gateway_from_dict(): + test_update_gateway(request_type=dict) + + +def test_update_gateway_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + client.update_gateway() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateGatewayRequest() + + +@pytest.mark.asyncio +async def test_update_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateGatewayRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_gateway_async_from_dict(): + await test_update_gateway_async(request_type=dict) + + +def test_update_gateway_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.UpdateGatewayRequest() + + request.gateway.name = 'gateway.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_gateway(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', + 'gateway.name=gateway.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_gateway_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.UpdateGatewayRequest() + + request.gateway.name = 'gateway.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_gateway(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', + 'gateway.name=gateway.name/value', + ) in kw['metadata'] + + +def test_update_gateway_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_gateway( + gateway=apigateway.Gateway(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].gateway == apigateway.Gateway(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_gateway_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_gateway( + apigateway.UpdateGatewayRequest(), + gateway=apigateway.Gateway(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_gateway_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_gateway( + gateway=apigateway.Gateway(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].gateway == apigateway.Gateway(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_gateway_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_gateway( + apigateway.UpdateGatewayRequest(), + gateway=apigateway.Gateway(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_gateway(transport: str = 'grpc', request_type=apigateway.DeleteGatewayRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_gateway_from_dict(): + test_delete_gateway(request_type=dict) + + +def test_delete_gateway_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + client.delete_gateway() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteGatewayRequest() + + +@pytest.mark.asyncio +async def test_delete_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteGatewayRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteGatewayRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_gateway_async_from_dict(): + await test_delete_gateway_async(request_type=dict) + + +def test_delete_gateway_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.DeleteGatewayRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_gateway_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.DeleteGatewayRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_gateway(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_delete_gateway_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_gateway( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_gateway_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_gateway( + apigateway.DeleteGatewayRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_gateway_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_gateway), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_gateway( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_gateway_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_gateway( + apigateway.DeleteGatewayRequest(), + name='name_value', + ) + + +def test_list_apis(transport: str = 'grpc', request_type=apigateway.ListApisRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApisResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + ) + response = client.list_apis(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApisRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListApisPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +def test_list_apis_from_dict(): + test_list_apis(request_type=dict) + + +def test_list_apis_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + client.list_apis() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApisRequest() + + +@pytest.mark.asyncio +async def test_list_apis_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListApisRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + )) + response = await client.list_apis(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApisRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListApisAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +@pytest.mark.asyncio +async def test_list_apis_async_from_dict(): + await test_list_apis_async(request_type=dict) + + +def test_list_apis_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.ListApisRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + call.return_value = apigateway.ListApisResponse() + client.list_apis(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_apis_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.ListApisRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse()) + await client.list_apis(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_list_apis_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApisResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_apis( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_apis_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_apis( + apigateway.ListApisRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_apis_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApisResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_apis( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_apis_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_apis( + apigateway.ListApisRequest(), + parent='parent_value', + ) + + +def test_list_apis_pager(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + apigateway.Api(), + ], + next_page_token='abc', + ), + apigateway.ListApisResponse( + apis=[], + next_page_token='def', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + ], + next_page_token='ghi', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_apis(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, apigateway.Api) + for i in results) + +def test_list_apis_pages(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + apigateway.Api(), + ], + next_page_token='abc', + ), + apigateway.ListApisResponse( + apis=[], + next_page_token='def', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + ], + next_page_token='ghi', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + ], + ), + RuntimeError, + ) + pages = list(client.list_apis(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_apis_async_pager(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + apigateway.Api(), + ], + next_page_token='abc', + ), + apigateway.ListApisResponse( + apis=[], + next_page_token='def', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + ], + next_page_token='ghi', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_apis(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, apigateway.Api) + for i in responses) + +@pytest.mark.asyncio +async def test_list_apis_async_pages(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_apis), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + apigateway.Api(), + ], + next_page_token='abc', + ), + apigateway.ListApisResponse( + apis=[], + next_page_token='def', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + ], + next_page_token='ghi', + ), + apigateway.ListApisResponse( + apis=[ + apigateway.Api(), + apigateway.Api(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_apis(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_api(transport: str = 'grpc', request_type=apigateway.GetApiRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Api( + name='name_value', + display_name='display_name_value', + managed_service='managed_service_value', + state=apigateway.Api.State.CREATING, + ) + response = client.get_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.Api) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.managed_service == 'managed_service_value' + assert response.state == apigateway.Api.State.CREATING + + +def test_get_api_from_dict(): + test_get_api(request_type=dict) + + +def test_get_api_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + client.get_api() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiRequest() + + +@pytest.mark.asyncio +async def test_get_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetApiRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api( + name='name_value', + display_name='display_name_value', + managed_service='managed_service_value', + state=apigateway.Api.State.CREATING, + )) + response = await client.get_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.Api) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.managed_service == 'managed_service_value' + assert response.state == apigateway.Api.State.CREATING + + +@pytest.mark.asyncio +async def test_get_api_async_from_dict(): + await test_get_api_async(request_type=dict) + + +def test_get_api_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.GetApiRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + call.return_value = apigateway.Api() + client.get_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_api_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.GetApiRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api()) + await client.get_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_get_api_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Api() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_api( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_api_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_api( + apigateway.GetApiRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_api_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.Api() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_api( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_api_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_api( + apigateway.GetApiRequest(), + name='name_value', + ) + + +def test_create_api(transport: str = 'grpc', request_type=apigateway.CreateApiRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_api_from_dict(): + test_create_api(request_type=dict) + + +def test_create_api_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + client.create_api() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiRequest() + + +@pytest.mark.asyncio +async def test_create_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateApiRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_api_async_from_dict(): + await test_create_api_async(request_type=dict) + + +def test_create_api_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.CreateApiRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_api_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.CreateApiRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_create_api_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_api( + parent='parent_value', + api=apigateway.Api(name='name_value'), + api_id='api_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].api == apigateway.Api(name='name_value') + assert args[0].api_id == 'api_id_value' + + +def test_create_api_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_api( + apigateway.CreateApiRequest(), + parent='parent_value', + api=apigateway.Api(name='name_value'), + api_id='api_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_api_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_api( + parent='parent_value', + api=apigateway.Api(name='name_value'), + api_id='api_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].api == apigateway.Api(name='name_value') + assert args[0].api_id == 'api_id_value' + + +@pytest.mark.asyncio +async def test_create_api_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_api( + apigateway.CreateApiRequest(), + parent='parent_value', + api=apigateway.Api(name='name_value'), + api_id='api_id_value', + ) + + +def test_update_api(transport: str = 'grpc', request_type=apigateway.UpdateApiRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_api_from_dict(): + test_update_api(request_type=dict) + + +def test_update_api_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + client.update_api() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiRequest() + + +@pytest.mark.asyncio +async def test_update_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateApiRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_api_async_from_dict(): + await test_update_api_async(request_type=dict) + + +def test_update_api_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.UpdateApiRequest() + + request.api.name = 'api.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_api(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', + 'api.name=api.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_api_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.UpdateApiRequest() + + request.api.name = 'api.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_api(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', + 'api.name=api.name/value', + ) in kw['metadata'] + + +def test_update_api_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_api( + api=apigateway.Api(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].api == apigateway.Api(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_api_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_api( + apigateway.UpdateApiRequest(), + api=apigateway.Api(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_api_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_api( + api=apigateway.Api(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].api == apigateway.Api(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_api_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_api( + apigateway.UpdateApiRequest(), + api=apigateway.Api(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_api(transport: str = 'grpc', request_type=apigateway.DeleteApiRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_api_from_dict(): + test_delete_api(request_type=dict) + + +def test_delete_api_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + client.delete_api() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiRequest() + + +@pytest.mark.asyncio +async def test_delete_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteApiRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_api_async_from_dict(): + await test_delete_api_async(request_type=dict) + + +def test_delete_api_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.DeleteApiRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_api_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.DeleteApiRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_api(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_delete_api_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_api( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_api_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_api( + apigateway.DeleteApiRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_api_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_api( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_api_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_api( + apigateway.DeleteApiRequest(), + name='name_value', + ) + + +def test_list_api_configs(transport: str = 'grpc', request_type=apigateway.ListApiConfigsRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApiConfigsResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + ) + response = client.list_api_configs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApiConfigsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListApiConfigsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +def test_list_api_configs_from_dict(): + test_list_api_configs(request_type=dict) + + +def test_list_api_configs_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + client.list_api_configs() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApiConfigsRequest() + + +@pytest.mark.asyncio +async def test_list_api_configs_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListApiConfigsRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse( + next_page_token='next_page_token_value', + unreachable_locations=['unreachable_locations_value'], + )) + response = await client.list_api_configs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.ListApiConfigsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListApiConfigsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable_locations == ['unreachable_locations_value'] + + +@pytest.mark.asyncio +async def test_list_api_configs_async_from_dict(): + await test_list_api_configs_async(request_type=dict) + + +def test_list_api_configs_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.ListApiConfigsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + call.return_value = apigateway.ListApiConfigsResponse() + client.list_api_configs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_api_configs_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.ListApiConfigsRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse()) + await client.list_api_configs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_list_api_configs_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApiConfigsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_api_configs( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +def test_list_api_configs_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_api_configs( + apigateway.ListApiConfigsRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_api_configs_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ListApiConfigsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_api_configs( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_api_configs_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_api_configs( + apigateway.ListApiConfigsRequest(), + parent='parent_value', + ) + + +def test_list_api_configs_pager(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + next_page_token='abc', + ), + apigateway.ListApiConfigsResponse( + api_configs=[], + next_page_token='def', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + ], + next_page_token='ghi', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_api_configs(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, apigateway.ApiConfig) + for i in results) + +def test_list_api_configs_pages(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + next_page_token='abc', + ), + apigateway.ListApiConfigsResponse( + api_configs=[], + next_page_token='def', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + ], + next_page_token='ghi', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + ), + RuntimeError, + ) + pages = list(client.list_api_configs(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_api_configs_async_pager(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + next_page_token='abc', + ), + apigateway.ListApiConfigsResponse( + api_configs=[], + next_page_token='def', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + ], + next_page_token='ghi', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_api_configs(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, apigateway.ApiConfig) + for i in responses) + +@pytest.mark.asyncio +async def test_list_api_configs_async_pages(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_api_configs), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + next_page_token='abc', + ), + apigateway.ListApiConfigsResponse( + api_configs=[], + next_page_token='def', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + ], + next_page_token='ghi', + ), + apigateway.ListApiConfigsResponse( + api_configs=[ + apigateway.ApiConfig(), + apigateway.ApiConfig(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_api_configs(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_get_api_config(transport: str = 'grpc', request_type=apigateway.GetApiConfigRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ApiConfig( + name='name_value', + display_name='display_name_value', + gateway_service_account='gateway_service_account_value', + service_config_id='service_config_id_value', + state=apigateway.ApiConfig.State.CREATING, + ) + response = client.get_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.ApiConfig) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.gateway_service_account == 'gateway_service_account_value' + assert response.service_config_id == 'service_config_id_value' + assert response.state == apigateway.ApiConfig.State.CREATING + + +def test_get_api_config_from_dict(): + test_get_api_config(request_type=dict) + + +def test_get_api_config_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + client.get_api_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiConfigRequest() + + +@pytest.mark.asyncio +async def test_get_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetApiConfigRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig( + name='name_value', + display_name='display_name_value', + gateway_service_account='gateway_service_account_value', + service_config_id='service_config_id_value', + state=apigateway.ApiConfig.State.CREATING, + )) + response = await client.get_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.GetApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, apigateway.ApiConfig) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + assert response.gateway_service_account == 'gateway_service_account_value' + assert response.service_config_id == 'service_config_id_value' + assert response.state == apigateway.ApiConfig.State.CREATING + + +@pytest.mark.asyncio +async def test_get_api_config_async_from_dict(): + await test_get_api_config_async(request_type=dict) + + +def test_get_api_config_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.GetApiConfigRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + call.return_value = apigateway.ApiConfig() + client.get_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_api_config_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.GetApiConfigRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig()) + await client.get_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_get_api_config_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ApiConfig() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_api_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_get_api_config_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_api_config( + apigateway.GetApiConfigRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_api_config_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = apigateway.ApiConfig() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_api_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_api_config_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_api_config( + apigateway.GetApiConfigRequest(), + name='name_value', + ) + + +def test_create_api_config(transport: str = 'grpc', request_type=apigateway.CreateApiConfigRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_api_config_from_dict(): + test_create_api_config(request_type=dict) + + +def test_create_api_config_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + client.create_api_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiConfigRequest() + + +@pytest.mark.asyncio +async def test_create_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateApiConfigRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.CreateApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_api_config_async_from_dict(): + await test_create_api_config_async(request_type=dict) + + +def test_create_api_config_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.CreateApiConfigRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_api_config_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.CreateApiConfigRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent/value', + ) in kw['metadata'] + + +def test_create_api_config_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_api_config( + parent='parent_value', + api_config=apigateway.ApiConfig(name='name_value'), + api_config_id='api_config_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].api_config == apigateway.ApiConfig(name='name_value') + assert args[0].api_config_id == 'api_config_id_value' + + +def test_create_api_config_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_api_config( + apigateway.CreateApiConfigRequest(), + parent='parent_value', + api_config=apigateway.ApiConfig(name='name_value'), + api_config_id='api_config_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_api_config_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_api_config( + parent='parent_value', + api_config=apigateway.ApiConfig(name='name_value'), + api_config_id='api_config_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].api_config == apigateway.ApiConfig(name='name_value') + assert args[0].api_config_id == 'api_config_id_value' + + +@pytest.mark.asyncio +async def test_create_api_config_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_api_config( + apigateway.CreateApiConfigRequest(), + parent='parent_value', + api_config=apigateway.ApiConfig(name='name_value'), + api_config_id='api_config_id_value', + ) + + +def test_update_api_config(transport: str = 'grpc', request_type=apigateway.UpdateApiConfigRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_api_config_from_dict(): + test_update_api_config(request_type=dict) + + +def test_update_api_config_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + client.update_api_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiConfigRequest() + + +@pytest.mark.asyncio +async def test_update_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateApiConfigRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.UpdateApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_api_config_async_from_dict(): + await test_update_api_config_async(request_type=dict) + + +def test_update_api_config_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.UpdateApiConfigRequest() + + request.api_config.name = 'api_config.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_api_config(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', + 'api_config.name=api_config.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_api_config_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.UpdateApiConfigRequest() + + request.api_config.name = 'api_config.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_api_config(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', + 'api_config.name=api_config.name/value', + ) in kw['metadata'] + + +def test_update_api_config_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_api_config( + api_config=apigateway.ApiConfig(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].api_config == apigateway.ApiConfig(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_api_config_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_api_config( + apigateway.UpdateApiConfigRequest(), + api_config=apigateway.ApiConfig(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_api_config_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_api_config( + api_config=apigateway.ApiConfig(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].api_config == apigateway.ApiConfig(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_api_config_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_api_config( + apigateway.UpdateApiConfigRequest(), + api_config=apigateway.ApiConfig(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_api_config(transport: str = 'grpc', request_type=apigateway.DeleteApiConfigRequest): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_api_config_from_dict(): + test_delete_api_config(request_type=dict) + + +def test_delete_api_config_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 = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + client.delete_api_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiConfigRequest() + + +@pytest.mark.asyncio +async def test_delete_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteApiConfigRequest): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == apigateway.DeleteApiConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_api_config_async_from_dict(): + await test_delete_api_config_async(request_type=dict) + + +def test_delete_api_config_field_headers(): + client = ApiGatewayServiceClient( + 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 = apigateway.DeleteApiConfigRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_api_config_field_headers_async(): + client = ApiGatewayServiceAsyncClient( + 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 = apigateway.DeleteApiConfigRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_api_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name/value', + ) in kw['metadata'] + + +def test_delete_api_config_flattened(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_api_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +def test_delete_api_config_flattened_error(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_api_config( + apigateway.DeleteApiConfigRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_api_config_flattened_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_api_config), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_api_config( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_api_config_flattened_error_async(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_api_config( + apigateway.DeleteApiConfigRequest(), + name='name_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ApiGatewayServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ApiGatewayServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ApiGatewayServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ApiGatewayServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ApiGatewayServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ApiGatewayServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ApiGatewayServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ApiGatewayServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ApiGatewayServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.ApiGatewayServiceGrpcTransport, + transports.ApiGatewayServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ApiGatewayServiceGrpcTransport, + ) + +def test_api_gateway_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ApiGatewayServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_api_gateway_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.ApiGatewayServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_gateways', + 'get_gateway', + 'create_gateway', + 'update_gateway', + 'delete_gateway', + 'list_apis', + 'get_api', + 'create_api', + 'update_api', + 'delete_api', + 'list_api_configs', + 'get_api_config', + 'create_api_config', + 'update_api_config', + 'delete_api_config', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + +@requires_google_auth_gte_1_25_0 +def test_api_gateway_service_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.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ApiGatewayServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_api_gateway_service_base_transport_with_credentials_file_old_google_auth(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ApiGatewayServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_api_gateway_service_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.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ApiGatewayServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_api_gateway_service_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) + ApiGatewayServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_api_gateway_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + ApiGatewayServiceClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ApiGatewayServiceGrpcTransport, + transports.ApiGatewayServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_api_gateway_service_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.ApiGatewayServiceGrpcTransport, + transports.ApiGatewayServiceGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_api_gateway_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.ApiGatewayServiceGrpcTransport, grpc_helpers), + (transports.ApiGatewayServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_api_gateway_service_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( + "apigateway.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="apigateway.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) +def test_api_gateway_service_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_api_gateway_service_host_no_port(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='apigateway.googleapis.com'), + ) + assert client.transport._host == 'apigateway.googleapis.com:443' + + +def test_api_gateway_service_host_with_port(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='apigateway.googleapis.com:8000'), + ) + assert client.transport._host == 'apigateway.googleapis.com:8000' + +def test_api_gateway_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ApiGatewayServiceGrpcTransport( + 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_api_gateway_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ApiGatewayServiceGrpcAsyncIOTransport( + 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.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) +def test_api_gateway_service_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.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) +def test_api_gateway_service_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_api_gateway_service_grpc_lro_client(): + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_api_gateway_service_grpc_lro_async_client(): + client = ApiGatewayServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_api_path(): + project = "squid" + api = "clam" + expected = "projects/{project}/locations/global/apis/{api}".format(project=project, api=api, ) + actual = ApiGatewayServiceClient.api_path(project, api) + assert expected == actual + + +def test_parse_api_path(): + expected = { + "project": "whelk", + "api": "octopus", + } + path = ApiGatewayServiceClient.api_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_api_path(path) + assert expected == actual + +def test_api_config_path(): + project = "oyster" + api = "nudibranch" + api_config = "cuttlefish" + expected = "projects/{project}/locations/global/apis/{api}/configs/{api_config}".format(project=project, api=api, api_config=api_config, ) + actual = ApiGatewayServiceClient.api_config_path(project, api, api_config) + assert expected == actual + + +def test_parse_api_config_path(): + expected = { + "project": "mussel", + "api": "winkle", + "api_config": "nautilus", + } + path = ApiGatewayServiceClient.api_config_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_api_config_path(path) + assert expected == actual + +def test_gateway_path(): + project = "scallop" + location = "abalone" + gateway = "squid" + expected = "projects/{project}/locations/{location}/gateways/{gateway}".format(project=project, location=location, gateway=gateway, ) + actual = ApiGatewayServiceClient.gateway_path(project, location, gateway) + assert expected == actual + + +def test_parse_gateway_path(): + expected = { + "project": "clam", + "location": "whelk", + "gateway": "octopus", + } + path = ApiGatewayServiceClient.gateway_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_gateway_path(path) + assert expected == actual + +def test_managed_service_path(): + service = "oyster" + expected = "services/{service}".format(service=service, ) + actual = ApiGatewayServiceClient.managed_service_path(service) + assert expected == actual + + +def test_parse_managed_service_path(): + expected = { + "service": "nudibranch", + } + path = ApiGatewayServiceClient.managed_service_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_managed_service_path(path) + assert expected == actual + +def test_service_path(): + service = "cuttlefish" + config = "mussel" + expected = "services/{service}/configs/{config}".format(service=service, config=config, ) + actual = ApiGatewayServiceClient.service_path(service, config) + assert expected == actual + + +def test_parse_service_path(): + expected = { + "service": "winkle", + "config": "nautilus", + } + path = ApiGatewayServiceClient.service_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_service_path(path) + assert expected == actual + +def test_service_account_path(): + project = "scallop" + service_account = "abalone" + expected = "projects/{project}/serviceAccounts/{service_account}".format(project=project, service_account=service_account, ) + actual = ApiGatewayServiceClient.service_account_path(project, service_account) + assert expected == actual + + +def test_parse_service_account_path(): + expected = { + "project": "squid", + "service_account": "clam", + } + path = ApiGatewayServiceClient.service_account_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_service_account_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = ApiGatewayServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = ApiGatewayServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format(folder=folder, ) + actual = ApiGatewayServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = ApiGatewayServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format(organization=organization, ) + actual = ApiGatewayServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = ApiGatewayServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format(project=project, ) + actual = ApiGatewayServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = ApiGatewayServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = ApiGatewayServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = ApiGatewayServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = ApiGatewayServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.ApiGatewayServiceTransport, '_prep_wrapped_messages') as prep: + client = ApiGatewayServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.ApiGatewayServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = ApiGatewayServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From d582ac3f8372d3164cdddbffcef84050a4e299d3 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 23 Jul 2021 21:31:20 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md --- .../services/api_gateway_service/client.py | 4 + owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - .../apigateway_v1/api_gateway_service.rst | 10 - .../v1/docs/apigateway_v1/services.rst | 6 - .../v1/docs/apigateway_v1/types.rst | 7 - owl-bot-staging/v1/docs/conf.py | 376 -- owl-bot-staging/v1/docs/index.rst | 7 - .../v1/google/cloud/apigateway/__init__.py | 67 - .../v1/google/cloud/apigateway/py.typed | 2 - .../v1/google/cloud/apigateway_v1/__init__.py | 68 - .../cloud/apigateway_v1/gapic_metadata.json | 173 - .../v1/google/cloud/apigateway_v1/py.typed | 2 - .../cloud/apigateway_v1/services/__init__.py | 15 - .../services/api_gateway_service/__init__.py | 22 - .../api_gateway_service/async_client.py | 1633 ------ .../services/api_gateway_service/client.py | 1806 ------ .../services/api_gateway_service/pagers.py | 384 -- .../transports/__init__.py | 33 - .../api_gateway_service/transports/base.py | 434 -- .../api_gateway_service/transports/grpc.py | 638 -- .../transports/grpc_asyncio.py | 642 -- .../cloud/apigateway_v1/types/__init__.py | 64 - .../cloud/apigateway_v1/types/apigateway.py | 941 --- .../apigateway_v1/types/apigateway_service.py | 25 - owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../scripts/fixup_apigateway_v1_keywords.py | 190 - owl-bot-staging/v1/setup.py | 54 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/apigateway_v1/__init__.py | 16 - .../apigateway_v1/test_api_gateway_service.py | 5205 ----------------- .../apigateway_v1/test_api_gateway_service.py | 31 +- 36 files changed, 22 insertions(+), 13084 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst delete mode 100644 owl-bot-staging/v1/docs/apigateway_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/apigateway_v1/types.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py delete mode 100644 owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py diff --git a/google/cloud/apigateway_v1/services/api_gateway_service/client.py b/google/cloud/apigateway_v1/services/api_gateway_service/client.py index ebb174f..c4eb0d0 100644 --- a/google/cloud/apigateway_v1/services/api_gateway_service/client.py +++ b/google/cloud/apigateway_v1/services/api_gateway_service/client.py @@ -424,6 +424,10 @@ def __init__( client_cert_source_for_mtls=client_cert_source_func, quota_project_id=client_options.quota_project_id, client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), ) def list_gateways( diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index a125c0b..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/apigateway/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 2c81722..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/apigateway *.py -recursive-include google/cloud/apigateway_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index d95ca32..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Apigateway 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 Apigateway API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst b/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst deleted file mode 100644 index 2f75173..0000000 --- a/owl-bot-staging/v1/docs/apigateway_v1/api_gateway_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -ApiGatewayService ------------------------------------ - -.. automodule:: google.cloud.apigateway_v1.services.api_gateway_service - :members: - :inherited-members: - -.. automodule:: google.cloud.apigateway_v1.services.api_gateway_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/apigateway_v1/services.rst b/owl-bot-staging/v1/docs/apigateway_v1/services.rst deleted file mode 100644 index 46a0db7..0000000 --- a/owl-bot-staging/v1/docs/apigateway_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Apigateway v1 API -=========================================== -.. toctree:: - :maxdepth: 2 - - api_gateway_service diff --git a/owl-bot-staging/v1/docs/apigateway_v1/types.rst b/owl-bot-staging/v1/docs/apigateway_v1/types.rst deleted file mode 100644 index 132f1b0..0000000 --- a/owl-bot-staging/v1/docs/apigateway_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Apigateway v1 API -======================================== - -.. automodule:: google.cloud.apigateway_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index fa594c9..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-api-gateway documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "1.6.3" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-api-gateway" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-api-gateway-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "google-cloud-api-gateway.tex", - u"google-cloud-api-gateway Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - master_doc, - "google-cloud-api-gateway", - u"Google Cloud Apigateway Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "google-cloud-api-gateway", - u"google-cloud-api-gateway Documentation", - author, - "google-cloud-api-gateway", - "GAPIC library for Google Cloud Apigateway API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index aa24547..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - apigateway_v1/services - apigateway_v1/types diff --git a/owl-bot-staging/v1/google/cloud/apigateway/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway/__init__.py deleted file mode 100644 index ba9ade8..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway/__init__.py +++ /dev/null @@ -1,67 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.cloud.apigateway_v1.services.api_gateway_service.client import ApiGatewayServiceClient -from google.cloud.apigateway_v1.services.api_gateway_service.async_client import ApiGatewayServiceAsyncClient - -from google.cloud.apigateway_v1.types.apigateway import Api -from google.cloud.apigateway_v1.types.apigateway import ApiConfig -from google.cloud.apigateway_v1.types.apigateway import CreateApiConfigRequest -from google.cloud.apigateway_v1.types.apigateway import CreateApiRequest -from google.cloud.apigateway_v1.types.apigateway import CreateGatewayRequest -from google.cloud.apigateway_v1.types.apigateway import DeleteApiConfigRequest -from google.cloud.apigateway_v1.types.apigateway import DeleteApiRequest -from google.cloud.apigateway_v1.types.apigateway import DeleteGatewayRequest -from google.cloud.apigateway_v1.types.apigateway import Gateway -from google.cloud.apigateway_v1.types.apigateway import GetApiConfigRequest -from google.cloud.apigateway_v1.types.apigateway import GetApiRequest -from google.cloud.apigateway_v1.types.apigateway import GetGatewayRequest -from google.cloud.apigateway_v1.types.apigateway import ListApiConfigsRequest -from google.cloud.apigateway_v1.types.apigateway import ListApiConfigsResponse -from google.cloud.apigateway_v1.types.apigateway import ListApisRequest -from google.cloud.apigateway_v1.types.apigateway import ListApisResponse -from google.cloud.apigateway_v1.types.apigateway import ListGatewaysRequest -from google.cloud.apigateway_v1.types.apigateway import ListGatewaysResponse -from google.cloud.apigateway_v1.types.apigateway import OperationMetadata -from google.cloud.apigateway_v1.types.apigateway import UpdateApiConfigRequest -from google.cloud.apigateway_v1.types.apigateway import UpdateApiRequest -from google.cloud.apigateway_v1.types.apigateway import UpdateGatewayRequest - -__all__ = ('ApiGatewayServiceClient', - 'ApiGatewayServiceAsyncClient', - 'Api', - 'ApiConfig', - 'CreateApiConfigRequest', - 'CreateApiRequest', - 'CreateGatewayRequest', - 'DeleteApiConfigRequest', - 'DeleteApiRequest', - 'DeleteGatewayRequest', - 'Gateway', - 'GetApiConfigRequest', - 'GetApiRequest', - 'GetGatewayRequest', - 'ListApiConfigsRequest', - 'ListApiConfigsResponse', - 'ListApisRequest', - 'ListApisResponse', - 'ListGatewaysRequest', - 'ListGatewaysResponse', - 'OperationMetadata', - 'UpdateApiConfigRequest', - 'UpdateApiRequest', - 'UpdateGatewayRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway/py.typed b/owl-bot-staging/v1/google/cloud/apigateway/py.typed deleted file mode 100644 index 49728b7..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-api-gateway package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py deleted file mode 100644 index f9b2401..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .services.api_gateway_service import ApiGatewayServiceClient -from .services.api_gateway_service import ApiGatewayServiceAsyncClient - -from .types.apigateway import Api -from .types.apigateway import ApiConfig -from .types.apigateway import CreateApiConfigRequest -from .types.apigateway import CreateApiRequest -from .types.apigateway import CreateGatewayRequest -from .types.apigateway import DeleteApiConfigRequest -from .types.apigateway import DeleteApiRequest -from .types.apigateway import DeleteGatewayRequest -from .types.apigateway import Gateway -from .types.apigateway import GetApiConfigRequest -from .types.apigateway import GetApiRequest -from .types.apigateway import GetGatewayRequest -from .types.apigateway import ListApiConfigsRequest -from .types.apigateway import ListApiConfigsResponse -from .types.apigateway import ListApisRequest -from .types.apigateway import ListApisResponse -from .types.apigateway import ListGatewaysRequest -from .types.apigateway import ListGatewaysResponse -from .types.apigateway import OperationMetadata -from .types.apigateway import UpdateApiConfigRequest -from .types.apigateway import UpdateApiRequest -from .types.apigateway import UpdateGatewayRequest - -__all__ = ( - 'ApiGatewayServiceAsyncClient', -'Api', -'ApiConfig', -'ApiGatewayServiceClient', -'CreateApiConfigRequest', -'CreateApiRequest', -'CreateGatewayRequest', -'DeleteApiConfigRequest', -'DeleteApiRequest', -'DeleteGatewayRequest', -'Gateway', -'GetApiConfigRequest', -'GetApiRequest', -'GetGatewayRequest', -'ListApiConfigsRequest', -'ListApiConfigsResponse', -'ListApisRequest', -'ListApisResponse', -'ListGatewaysRequest', -'ListGatewaysResponse', -'OperationMetadata', -'UpdateApiConfigRequest', -'UpdateApiRequest', -'UpdateGatewayRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json deleted file mode 100644 index 2e07036..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/gapic_metadata.json +++ /dev/null @@ -1,173 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.apigateway_v1", - "protoPackage": "google.cloud.apigateway.v1", - "schema": "1.0", - "services": { - "ApiGatewayService": { - "clients": { - "grpc": { - "libraryClient": "ApiGatewayServiceClient", - "rpcs": { - "CreateApi": { - "methods": [ - "create_api" - ] - }, - "CreateApiConfig": { - "methods": [ - "create_api_config" - ] - }, - "CreateGateway": { - "methods": [ - "create_gateway" - ] - }, - "DeleteApi": { - "methods": [ - "delete_api" - ] - }, - "DeleteApiConfig": { - "methods": [ - "delete_api_config" - ] - }, - "DeleteGateway": { - "methods": [ - "delete_gateway" - ] - }, - "GetApi": { - "methods": [ - "get_api" - ] - }, - "GetApiConfig": { - "methods": [ - "get_api_config" - ] - }, - "GetGateway": { - "methods": [ - "get_gateway" - ] - }, - "ListApiConfigs": { - "methods": [ - "list_api_configs" - ] - }, - "ListApis": { - "methods": [ - "list_apis" - ] - }, - "ListGateways": { - "methods": [ - "list_gateways" - ] - }, - "UpdateApi": { - "methods": [ - "update_api" - ] - }, - "UpdateApiConfig": { - "methods": [ - "update_api_config" - ] - }, - "UpdateGateway": { - "methods": [ - "update_gateway" - ] - } - } - }, - "grpc-async": { - "libraryClient": "ApiGatewayServiceAsyncClient", - "rpcs": { - "CreateApi": { - "methods": [ - "create_api" - ] - }, - "CreateApiConfig": { - "methods": [ - "create_api_config" - ] - }, - "CreateGateway": { - "methods": [ - "create_gateway" - ] - }, - "DeleteApi": { - "methods": [ - "delete_api" - ] - }, - "DeleteApiConfig": { - "methods": [ - "delete_api_config" - ] - }, - "DeleteGateway": { - "methods": [ - "delete_gateway" - ] - }, - "GetApi": { - "methods": [ - "get_api" - ] - }, - "GetApiConfig": { - "methods": [ - "get_api_config" - ] - }, - "GetGateway": { - "methods": [ - "get_gateway" - ] - }, - "ListApiConfigs": { - "methods": [ - "list_api_configs" - ] - }, - "ListApis": { - "methods": [ - "list_apis" - ] - }, - "ListGateways": { - "methods": [ - "list_gateways" - ] - }, - "UpdateApi": { - "methods": [ - "update_api" - ] - }, - "UpdateApiConfig": { - "methods": [ - "update_api_config" - ] - }, - "UpdateGateway": { - "methods": [ - "update_gateway" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed b/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed deleted file mode 100644 index 49728b7..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-api-gateway package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py deleted file mode 100644 index 3683170..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import ApiGatewayServiceClient -from .async_client import ApiGatewayServiceAsyncClient - -__all__ = ( - 'ApiGatewayServiceClient', - 'ApiGatewayServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py deleted file mode 100644 index 0785110..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/async_client.py +++ /dev/null @@ -1,1633 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.apigateway_v1.services.api_gateway_service import pagers -from google.cloud.apigateway_v1.types import apigateway -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport -from .client import ApiGatewayServiceClient - - -class ApiGatewayServiceAsyncClient: - """The API Gateway Service is the interface for managing API - Gateways. - """ - - _client: ApiGatewayServiceClient - - DEFAULT_ENDPOINT = ApiGatewayServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = ApiGatewayServiceClient.DEFAULT_MTLS_ENDPOINT - - api_path = staticmethod(ApiGatewayServiceClient.api_path) - parse_api_path = staticmethod(ApiGatewayServiceClient.parse_api_path) - api_config_path = staticmethod(ApiGatewayServiceClient.api_config_path) - parse_api_config_path = staticmethod(ApiGatewayServiceClient.parse_api_config_path) - gateway_path = staticmethod(ApiGatewayServiceClient.gateway_path) - parse_gateway_path = staticmethod(ApiGatewayServiceClient.parse_gateway_path) - managed_service_path = staticmethod(ApiGatewayServiceClient.managed_service_path) - parse_managed_service_path = staticmethod(ApiGatewayServiceClient.parse_managed_service_path) - service_path = staticmethod(ApiGatewayServiceClient.service_path) - parse_service_path = staticmethod(ApiGatewayServiceClient.parse_service_path) - service_account_path = staticmethod(ApiGatewayServiceClient.service_account_path) - parse_service_account_path = staticmethod(ApiGatewayServiceClient.parse_service_account_path) - common_billing_account_path = staticmethod(ApiGatewayServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(ApiGatewayServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(ApiGatewayServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(ApiGatewayServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(ApiGatewayServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(ApiGatewayServiceClient.parse_common_organization_path) - common_project_path = staticmethod(ApiGatewayServiceClient.common_project_path) - parse_common_project_path = staticmethod(ApiGatewayServiceClient.parse_common_project_path) - common_location_path = staticmethod(ApiGatewayServiceClient.common_location_path) - parse_common_location_path = staticmethod(ApiGatewayServiceClient.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: - ApiGatewayServiceAsyncClient: The constructed client. - """ - return ApiGatewayServiceClient.from_service_account_info.__func__(ApiGatewayServiceAsyncClient, 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: - ApiGatewayServiceAsyncClient: The constructed client. - """ - return ApiGatewayServiceClient.from_service_account_file.__func__(ApiGatewayServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> ApiGatewayServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ApiGatewayServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(ApiGatewayServiceClient).get_transport_class, type(ApiGatewayServiceClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, ApiGatewayServiceTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the api gateway service 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, ~.ApiGatewayServiceTransport]): 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 = ApiGatewayServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def list_gateways(self, - request: apigateway.ListGatewaysRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGatewaysAsyncPager: - r"""Lists Gateways in a given project and location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.ListGatewaysRequest`): - The request object. Request message for - ApiGatewayService.ListGateways - parent (:class:`str`): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysAsyncPager: - Response message for - ApiGatewayService.ListGateways - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.ListGatewaysRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_gateways, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListGatewaysAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_gateway(self, - request: apigateway.GetGatewayRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.Gateway: - r"""Gets details of a single Gateway. - - Args: - request (:class:`google.cloud.apigateway_v1.types.GetGatewayRequest`): - The request object. Request message for - ApiGatewayService.GetGateway - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.Gateway: - A Gateway is an API-aware HTTP proxy. - It performs API-Method and/or API- - Consumer specific actions based on an - API Config such as authentication, - policy enforcement, and backend - selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.GetGatewayRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_gateway, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_gateway(self, - request: apigateway.CreateGatewayRequest = None, - *, - parent: str = None, - gateway: apigateway.Gateway = None, - gateway_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Creates a new Gateway in a given project and - location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.CreateGatewayRequest`): - The request object. Request message for - ApiGatewayService.CreateGateway - parent (:class:`str`): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - gateway (:class:`google.cloud.apigateway_v1.types.Gateway`): - Required. Gateway resource. - This corresponds to the ``gateway`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - gateway_id (:class:`str`): - Required. Identifier to assign to the - Gateway. Must be unique within scope of - the parent resource. - - This corresponds to the ``gateway_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or - API-Consumer specific actions based on an API Config - such as authentication, policy enforcement, and - backend selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, gateway, gateway_id]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.CreateGatewayRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if gateway is not None: - request.gateway = gateway - if gateway_id is not None: - request.gateway_id = gateway_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.Gateway, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def update_gateway(self, - request: apigateway.UpdateGatewayRequest = None, - *, - gateway: apigateway.Gateway = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates the parameters of a single Gateway. - - Args: - request (:class:`google.cloud.apigateway_v1.types.UpdateGatewayRequest`): - The request object. Request message for - ApiGatewayService.UpdateGateway - gateway (:class:`google.cloud.apigateway_v1.types.Gateway`): - Required. Gateway resource. - This corresponds to the ``gateway`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Field mask is used to specify the fields to be - overwritten in the Gateway resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or - API-Consumer specific actions based on an API Config - such as authentication, policy enforcement, and - backend selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([gateway, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.UpdateGatewayRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if gateway is not None: - request.gateway = gateway - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("gateway.name", request.gateway.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.Gateway, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def delete_gateway(self, - request: apigateway.DeleteGatewayRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a single Gateway. - - Args: - request (:class:`google.cloud.apigateway_v1.types.DeleteGatewayRequest`): - The request object. Request message for - ApiGatewayService.DeleteGateway - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.DeleteGatewayRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def list_apis(self, - request: apigateway.ListApisRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListApisAsyncPager: - r"""Lists Apis in a given project and location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.ListApisRequest`): - The request object. Request message for - ApiGatewayService.ListApis - parent (:class:`str`): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisAsyncPager: - Response message for - ApiGatewayService.ListApis - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.ListApisRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_apis, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListApisAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_api(self, - request: apigateway.GetApiRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.Api: - r"""Gets details of a single Api. - - Args: - request (:class:`google.cloud.apigateway_v1.types.GetApiRequest`): - The request object. Request message for - ApiGatewayService.GetApi - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.Api: - An API that can be served by one or - more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.GetApiRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_api, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_api(self, - request: apigateway.CreateApiRequest = None, - *, - parent: str = None, - api: apigateway.Api = None, - api_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Creates a new Api in a given project and location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.CreateApiRequest`): - The request object. Request message for - ApiGatewayService.CreateApi - parent (:class:`str`): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api (:class:`google.cloud.apigateway_v1.types.Api`): - Required. API resource. - This corresponds to the ``api`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_id (:class:`str`): - Required. Identifier to assign to the - API. Must be unique within scope of the - parent resource. - - This corresponds to the ``api_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.apigateway_v1.types.Api` An API - that can be served by one or more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, api, api_id]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.CreateApiRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if api is not None: - request.api = api - if api_id is not None: - request.api_id = api_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.Api, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def update_api(self, - request: apigateway.UpdateApiRequest = None, - *, - api: apigateway.Api = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates the parameters of a single Api. - - Args: - request (:class:`google.cloud.apigateway_v1.types.UpdateApiRequest`): - The request object. Request message for - ApiGatewayService.UpdateApi - api (:class:`google.cloud.apigateway_v1.types.Api`): - Required. API resource. - This corresponds to the ``api`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Field mask is used to specify the fields to be - overwritten in the Api resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.apigateway_v1.types.Api` An API - that can be served by one or more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([api, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.UpdateApiRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if api is not None: - request.api = api - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("api.name", request.api.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.Api, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def delete_api(self, - request: apigateway.DeleteApiRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a single Api. - - Args: - request (:class:`google.cloud.apigateway_v1.types.DeleteApiRequest`): - The request object. Request message for - ApiGatewayService.DeleteApi - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.DeleteApiRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def list_api_configs(self, - request: apigateway.ListApiConfigsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListApiConfigsAsyncPager: - r"""Lists ApiConfigs in a given project and location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.ListApiConfigsRequest`): - The request object. Request message for - ApiGatewayService.ListApiConfigs - parent (:class:`str`): - Required. Parent resource of the API Config, of the - form: ``projects/*/locations/global/apis/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsAsyncPager: - Response message for - ApiGatewayService.ListApiConfigs - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.ListApiConfigsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_api_configs, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListApiConfigsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_api_config(self, - request: apigateway.GetApiConfigRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.ApiConfig: - r"""Gets details of a single ApiConfig. - - Args: - request (:class:`google.cloud.apigateway_v1.types.GetApiConfigRequest`): - The request object. Request message for - ApiGatewayService.GetApiConfig - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.ApiConfig: - An API Configuration is a combination - of settings for both the Managed Service - and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.GetApiConfigRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_api_config, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_api_config(self, - request: apigateway.CreateApiConfigRequest = None, - *, - parent: str = None, - api_config: apigateway.ApiConfig = None, - api_config_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Creates a new ApiConfig in a given project and - location. - - Args: - request (:class:`google.cloud.apigateway_v1.types.CreateApiConfigRequest`): - The request object. Request message for - ApiGatewayService.CreateApiConfig - parent (:class:`str`): - Required. Parent resource of the API Config, of the - form: ``projects/*/locations/global/apis/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_config (:class:`google.cloud.apigateway_v1.types.ApiConfig`): - Required. API resource. - This corresponds to the ``api_config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_config_id (:class:`str`): - Required. Identifier to assign to the - API Config. Must be unique within scope - of the parent resource. - - This corresponds to the ``api_config_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed - Service and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, api_config, api_config_id]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.CreateApiConfigRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if api_config is not None: - request.api_config = api_config - if api_config_id is not None: - request.api_config_id = api_config_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.ApiConfig, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def update_api_config(self, - request: apigateway.UpdateApiConfigRequest = None, - *, - api_config: apigateway.ApiConfig = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Updates the parameters of a single ApiConfig. - - Args: - request (:class:`google.cloud.apigateway_v1.types.UpdateApiConfigRequest`): - The request object. Request message for - ApiGatewayService.UpdateApiConfig - api_config (:class:`google.cloud.apigateway_v1.types.ApiConfig`): - Required. API Config resource. - This corresponds to the ``api_config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Field mask is used to specify the fields to be - overwritten in the ApiConfig resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed - Service and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([api_config, update_mask]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.UpdateApiConfigRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if api_config is not None: - request.api_config = api_config - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("api_config.name", request.api_config.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - apigateway.ApiConfig, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - async def delete_api_config(self, - request: apigateway.DeleteApiConfigRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a single ApiConfig. - - Args: - request (:class:`google.cloud.apigateway_v1.types.DeleteApiConfigRequest`): - The request object. Request message for - ApiGatewayService.DeleteApiConfig - name (:class:`str`): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = apigateway.DeleteApiConfigRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-api-gateway", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "ApiGatewayServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py deleted file mode 100644 index 24015bf..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/client.py +++ /dev/null @@ -1,1806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.apigateway_v1.services.api_gateway_service import pagers -from google.cloud.apigateway_v1.types import apigateway -from google.protobuf import empty_pb2 # type: ignore -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import ApiGatewayServiceGrpcTransport -from .transports.grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport - - -class ApiGatewayServiceClientMeta(type): - """Metaclass for the ApiGatewayService 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[ApiGatewayServiceTransport]] - _transport_registry["grpc"] = ApiGatewayServiceGrpcTransport - _transport_registry["grpc_asyncio"] = ApiGatewayServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[ApiGatewayServiceTransport]: - """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 ApiGatewayServiceClient(metaclass=ApiGatewayServiceClientMeta): - """The API Gateway Service is the interface for managing API - Gateways. - """ - - @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 = "apigateway.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: - ApiGatewayServiceClient: 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: - ApiGatewayServiceClient: 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) -> ApiGatewayServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ApiGatewayServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def api_path(project: str,api: str,) -> str: - """Returns a fully-qualified api string.""" - return "projects/{project}/locations/global/apis/{api}".format(project=project, api=api, ) - - @staticmethod - def parse_api_path(path: str) -> Dict[str,str]: - """Parses a api path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/global/apis/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def api_config_path(project: str,api: str,api_config: str,) -> str: - """Returns a fully-qualified api_config string.""" - return "projects/{project}/locations/global/apis/{api}/configs/{api_config}".format(project=project, api=api, api_config=api_config, ) - - @staticmethod - def parse_api_config_path(path: str) -> Dict[str,str]: - """Parses a api_config path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/global/apis/(?P.+?)/configs/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def gateway_path(project: str,location: str,gateway: str,) -> str: - """Returns a fully-qualified gateway string.""" - return "projects/{project}/locations/{location}/gateways/{gateway}".format(project=project, location=location, gateway=gateway, ) - - @staticmethod - def parse_gateway_path(path: str) -> Dict[str,str]: - """Parses a gateway path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/gateways/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def managed_service_path(service: str,) -> str: - """Returns a fully-qualified managed_service string.""" - return "services/{service}".format(service=service, ) - - @staticmethod - def parse_managed_service_path(path: str) -> Dict[str,str]: - """Parses a managed_service path into its component segments.""" - m = re.match(r"^services/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def service_path(service: str,config: str,) -> str: - """Returns a fully-qualified service string.""" - return "services/{service}/configs/{config}".format(service=service, config=config, ) - - @staticmethod - def parse_service_path(path: str) -> Dict[str,str]: - """Parses a service path into its component segments.""" - m = re.match(r"^services/(?P.+?)/configs/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def service_account_path(project: str,service_account: str,) -> str: - """Returns a fully-qualified service_account string.""" - return "projects/{project}/serviceAccounts/{service_account}".format(project=project, service_account=service_account, ) - - @staticmethod - def parse_service_account_path(path: str) -> Dict[str,str]: - """Parses a service_account path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/serviceAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, ApiGatewayServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the api gateway service 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, ApiGatewayServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, ApiGatewayServiceTransport): - # transport is a ApiGatewayServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=( - Transport == type(self).get_transport_class("grpc") - or Transport == type(self).get_transport_class("grpc_asyncio") - ), - ) - - def list_gateways(self, - request: apigateway.ListGatewaysRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGatewaysPager: - r"""Lists Gateways in a given project and location. - - Args: - request (google.cloud.apigateway_v1.types.ListGatewaysRequest): - The request object. Request message for - ApiGatewayService.ListGateways - parent (str): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysPager: - Response message for - ApiGatewayService.ListGateways - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.ListGatewaysRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.ListGatewaysRequest): - request = apigateway.ListGatewaysRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_gateways] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListGatewaysPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_gateway(self, - request: apigateway.GetGatewayRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.Gateway: - r"""Gets details of a single Gateway. - - Args: - request (google.cloud.apigateway_v1.types.GetGatewayRequest): - The request object. Request message for - ApiGatewayService.GetGateway - name (str): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.Gateway: - A Gateway is an API-aware HTTP proxy. - It performs API-Method and/or API- - Consumer specific actions based on an - API Config such as authentication, - policy enforcement, and backend - selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.GetGatewayRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.GetGatewayRequest): - request = apigateway.GetGatewayRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_gateway] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_gateway(self, - request: apigateway.CreateGatewayRequest = None, - *, - parent: str = None, - gateway: apigateway.Gateway = None, - gateway_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Creates a new Gateway in a given project and - location. - - Args: - request (google.cloud.apigateway_v1.types.CreateGatewayRequest): - The request object. Request message for - ApiGatewayService.CreateGateway - parent (str): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - gateway (google.cloud.apigateway_v1.types.Gateway): - Required. Gateway resource. - This corresponds to the ``gateway`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - gateway_id (str): - Required. Identifier to assign to the - Gateway. Must be unique within scope of - the parent resource. - - This corresponds to the ``gateway_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or - API-Consumer specific actions based on an API Config - such as authentication, policy enforcement, and - backend selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, gateway, gateway_id]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.CreateGatewayRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.CreateGatewayRequest): - request = apigateway.CreateGatewayRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if gateway is not None: - request.gateway = gateway - if gateway_id is not None: - request.gateway_id = gateway_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_gateway] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.Gateway, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def update_gateway(self, - request: apigateway.UpdateGatewayRequest = None, - *, - gateway: apigateway.Gateway = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates the parameters of a single Gateway. - - Args: - request (google.cloud.apigateway_v1.types.UpdateGatewayRequest): - The request object. Request message for - ApiGatewayService.UpdateGateway - gateway (google.cloud.apigateway_v1.types.Gateway): - Required. Gateway resource. - This corresponds to the ``gateway`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be - overwritten in the Gateway resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.Gateway` A Gateway is an API-aware HTTP proxy. It performs API-Method and/or - API-Consumer specific actions based on an API Config - such as authentication, policy enforcement, and - backend selection. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([gateway, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.UpdateGatewayRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.UpdateGatewayRequest): - request = apigateway.UpdateGatewayRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if gateway is not None: - request.gateway = gateway - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_gateway] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("gateway.name", request.gateway.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.Gateway, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def delete_gateway(self, - request: apigateway.DeleteGatewayRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a single Gateway. - - Args: - request (google.cloud.apigateway_v1.types.DeleteGatewayRequest): - The request object. Request message for - ApiGatewayService.DeleteGateway - name (str): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.DeleteGatewayRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.DeleteGatewayRequest): - request = apigateway.DeleteGatewayRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_gateway] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def list_apis(self, - request: apigateway.ListApisRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListApisPager: - r"""Lists Apis in a given project and location. - - Args: - request (google.cloud.apigateway_v1.types.ListApisRequest): - The request object. Request message for - ApiGatewayService.ListApis - parent (str): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisPager: - Response message for - ApiGatewayService.ListApis - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.ListApisRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.ListApisRequest): - request = apigateway.ListApisRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_apis] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListApisPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_api(self, - request: apigateway.GetApiRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.Api: - r"""Gets details of a single Api. - - Args: - request (google.cloud.apigateway_v1.types.GetApiRequest): - The request object. Request message for - ApiGatewayService.GetApi - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.Api: - An API that can be served by one or - more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.GetApiRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.GetApiRequest): - request = apigateway.GetApiRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_api] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_api(self, - request: apigateway.CreateApiRequest = None, - *, - parent: str = None, - api: apigateway.Api = None, - api_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Creates a new Api in a given project and location. - - Args: - request (google.cloud.apigateway_v1.types.CreateApiRequest): - The request object. Request message for - ApiGatewayService.CreateApi - parent (str): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api (google.cloud.apigateway_v1.types.Api): - Required. API resource. - This corresponds to the ``api`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_id (str): - Required. Identifier to assign to the - API. Must be unique within scope of the - parent resource. - - This corresponds to the ``api_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.apigateway_v1.types.Api` An API - that can be served by one or more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, api, api_id]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.CreateApiRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.CreateApiRequest): - request = apigateway.CreateApiRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if api is not None: - request.api = api - if api_id is not None: - request.api_id = api_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_api] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.Api, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def update_api(self, - request: apigateway.UpdateApiRequest = None, - *, - api: apigateway.Api = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates the parameters of a single Api. - - Args: - request (google.cloud.apigateway_v1.types.UpdateApiRequest): - The request object. Request message for - ApiGatewayService.UpdateApi - api (google.cloud.apigateway_v1.types.Api): - Required. API resource. - This corresponds to the ``api`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be - overwritten in the Api resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.apigateway_v1.types.Api` An API - that can be served by one or more Gateways. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([api, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.UpdateApiRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.UpdateApiRequest): - request = apigateway.UpdateApiRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if api is not None: - request.api = api - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_api] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("api.name", request.api.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.Api, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def delete_api(self, - request: apigateway.DeleteApiRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a single Api. - - Args: - request (google.cloud.apigateway_v1.types.DeleteApiRequest): - The request object. Request message for - ApiGatewayService.DeleteApi - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.DeleteApiRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.DeleteApiRequest): - request = apigateway.DeleteApiRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_api] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def list_api_configs(self, - request: apigateway.ListApiConfigsRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListApiConfigsPager: - r"""Lists ApiConfigs in a given project and location. - - Args: - request (google.cloud.apigateway_v1.types.ListApiConfigsRequest): - The request object. Request message for - ApiGatewayService.ListApiConfigs - parent (str): - Required. Parent resource of the API Config, of the - form: ``projects/*/locations/global/apis/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsPager: - Response message for - ApiGatewayService.ListApiConfigs - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.ListApiConfigsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.ListApiConfigsRequest): - request = apigateway.ListApiConfigsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_api_configs] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListApiConfigsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_api_config(self, - request: apigateway.GetApiConfigRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> apigateway.ApiConfig: - r"""Gets details of a single ApiConfig. - - Args: - request (google.cloud.apigateway_v1.types.GetApiConfigRequest): - The request object. Request message for - ApiGatewayService.GetApiConfig - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.apigateway_v1.types.ApiConfig: - An API Configuration is a combination - of settings for both the Managed Service - and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.GetApiConfigRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.GetApiConfigRequest): - request = apigateway.GetApiConfigRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_api_config] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_api_config(self, - request: apigateway.CreateApiConfigRequest = None, - *, - parent: str = None, - api_config: apigateway.ApiConfig = None, - api_config_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Creates a new ApiConfig in a given project and - location. - - Args: - request (google.cloud.apigateway_v1.types.CreateApiConfigRequest): - The request object. Request message for - ApiGatewayService.CreateApiConfig - parent (str): - Required. Parent resource of the API Config, of the - form: ``projects/*/locations/global/apis/*`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_config (google.cloud.apigateway_v1.types.ApiConfig): - Required. API resource. - This corresponds to the ``api_config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - api_config_id (str): - Required. Identifier to assign to the - API Config. Must be unique within scope - of the parent resource. - - This corresponds to the ``api_config_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed - Service and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, api_config, api_config_id]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.CreateApiConfigRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.CreateApiConfigRequest): - request = apigateway.CreateApiConfigRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if api_config is not None: - request.api_config = api_config - if api_config_id is not None: - request.api_config_id = api_config_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_api_config] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.ApiConfig, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def update_api_config(self, - request: apigateway.UpdateApiConfigRequest = None, - *, - api_config: apigateway.ApiConfig = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Updates the parameters of a single ApiConfig. - - Args: - request (google.cloud.apigateway_v1.types.UpdateApiConfigRequest): - The request object. Request message for - ApiGatewayService.UpdateApiConfig - api_config (google.cloud.apigateway_v1.types.ApiConfig): - Required. API Config resource. - This corresponds to the ``api_config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be - overwritten in the ApiConfig resource by the update. The - fields specified in the update_mask are relative to the - resource, not the full request. A field will be - overwritten if it is in the mask. If the user does not - provide a mask then all fields will be overwritten. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.apigateway_v1.types.ApiConfig` An API Configuration is a combination of settings for both the Managed - Service and Gateways serving this API Config. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([api_config, update_mask]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.UpdateApiConfigRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.UpdateApiConfigRequest): - request = apigateway.UpdateApiConfigRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if api_config is not None: - request.api_config = api_config - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_api_config] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("api_config.name", request.api_config.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - apigateway.ApiConfig, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - def delete_api_config(self, - request: apigateway.DeleteApiConfigRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a single ApiConfig. - - Args: - request (google.cloud.apigateway_v1.types.DeleteApiConfigRequest): - The request object. Request message for - ApiGatewayService.DeleteApiConfig - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } - - The JSON representation for Empty is empty JSON - object {}. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a apigateway.DeleteApiConfigRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, apigateway.DeleteApiConfigRequest): - request = apigateway.DeleteApiConfigRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_api_config] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - empty_pb2.Empty, - metadata_type=apigateway.OperationMetadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-api-gateway", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "ApiGatewayServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py deleted file mode 100644 index e36acb8..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/pagers.py +++ /dev/null @@ -1,384 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional - -from google.cloud.apigateway_v1.types import apigateway - - -class ListGatewaysPager: - """A pager for iterating through ``list_gateways`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` object, and - provides an ``__iter__`` method to iterate through its - ``gateways`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListGateways`` requests and continue to iterate - through the ``gateways`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` - 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[..., apigateway.ListGatewaysResponse], - request: apigateway.ListGatewaysRequest, - response: apigateway.ListGatewaysResponse, - *, - 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.apigateway_v1.types.ListGatewaysRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListGatewaysResponse): - 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 = apigateway.ListGatewaysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[apigateway.ListGatewaysResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterable[apigateway.Gateway]: - for page in self.pages: - yield from page.gateways - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListGatewaysAsyncPager: - """A pager for iterating through ``list_gateways`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``gateways`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListGateways`` requests and continue to iterate - through the ``gateways`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListGatewaysResponse` - 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[apigateway.ListGatewaysResponse]], - request: apigateway.ListGatewaysRequest, - response: apigateway.ListGatewaysResponse, - *, - 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.apigateway_v1.types.ListGatewaysRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListGatewaysResponse): - 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 = apigateway.ListGatewaysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[apigateway.ListGatewaysResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - - def __aiter__(self) -> AsyncIterable[apigateway.Gateway]: - async def async_generator(): - async for page in self.pages: - for response in page.gateways: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListApisPager: - """A pager for iterating through ``list_apis`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListApisResponse` object, and - provides an ``__iter__`` method to iterate through its - ``apis`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListApis`` requests and continue to iterate - through the ``apis`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListApisResponse` - 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[..., apigateway.ListApisResponse], - request: apigateway.ListApisRequest, - response: apigateway.ListApisResponse, - *, - 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.apigateway_v1.types.ListApisRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListApisResponse): - 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 = apigateway.ListApisRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[apigateway.ListApisResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterable[apigateway.Api]: - for page in self.pages: - yield from page.apis - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListApisAsyncPager: - """A pager for iterating through ``list_apis`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListApisResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``apis`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListApis`` requests and continue to iterate - through the ``apis`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListApisResponse` - 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[apigateway.ListApisResponse]], - request: apigateway.ListApisRequest, - response: apigateway.ListApisResponse, - *, - 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.apigateway_v1.types.ListApisRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListApisResponse): - 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 = apigateway.ListApisRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[apigateway.ListApisResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - - def __aiter__(self) -> AsyncIterable[apigateway.Api]: - async def async_generator(): - async for page in self.pages: - for response in page.apis: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListApiConfigsPager: - """A pager for iterating through ``list_api_configs`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``api_configs`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListApiConfigs`` requests and continue to iterate - through the ``api_configs`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` - 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[..., apigateway.ListApiConfigsResponse], - request: apigateway.ListApiConfigsRequest, - response: apigateway.ListApiConfigsResponse, - *, - 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.apigateway_v1.types.ListApiConfigsRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListApiConfigsResponse): - 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 = apigateway.ListApiConfigsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[apigateway.ListApiConfigsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterable[apigateway.ApiConfig]: - for page in self.pages: - yield from page.api_configs - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListApiConfigsAsyncPager: - """A pager for iterating through ``list_api_configs`` requests. - - This class thinly wraps an initial - :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``api_configs`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListApiConfigs`` requests and continue to iterate - through the ``api_configs`` field on the - corresponding responses. - - All the usual :class:`google.cloud.apigateway_v1.types.ListApiConfigsResponse` - 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[apigateway.ListApiConfigsResponse]], - request: apigateway.ListApiConfigsRequest, - response: apigateway.ListApiConfigsResponse, - *, - 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.apigateway_v1.types.ListApiConfigsRequest): - The initial request object. - response (google.cloud.apigateway_v1.types.ListApiConfigsResponse): - 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 = apigateway.ListApiConfigsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[apigateway.ListApiConfigsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - - def __aiter__(self) -> AsyncIterable[apigateway.ApiConfig]: - async def async_generator(): - async for page in self.pages: - for response in page.api_configs: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py deleted file mode 100644 index d6a7980..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import ApiGatewayServiceTransport -from .grpc import ApiGatewayServiceGrpcTransport -from .grpc_asyncio import ApiGatewayServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[ApiGatewayServiceTransport]] -_transport_registry['grpc'] = ApiGatewayServiceGrpcTransport -_transport_registry['grpc_asyncio'] = ApiGatewayServiceGrpcAsyncIOTransport - -__all__ = ( - 'ApiGatewayServiceTransport', - 'ApiGatewayServiceGrpcTransport', - 'ApiGatewayServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py deleted file mode 100644 index 56d62e8..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/base.py +++ /dev/null @@ -1,434 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.apigateway_v1.types import apigateway -from google.longrunning import operations_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-api-gateway', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class ApiGatewayServiceTransport(abc.ABC): - """Abstract transport class for ApiGatewayService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'apigateway.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials is service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.list_gateways: gapic_v1.method.wrap_method( - self.list_gateways, - default_timeout=None, - client_info=client_info, - ), - self.get_gateway: gapic_v1.method.wrap_method( - self.get_gateway, - default_timeout=None, - client_info=client_info, - ), - self.create_gateway: gapic_v1.method.wrap_method( - self.create_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_gateway: gapic_v1.method.wrap_method( - self.update_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_gateway: gapic_v1.method.wrap_method( - self.delete_gateway, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.list_apis: gapic_v1.method.wrap_method( - self.list_apis, - default_timeout=None, - client_info=client_info, - ), - self.get_api: gapic_v1.method.wrap_method( - self.get_api, - default_timeout=None, - client_info=client_info, - ), - self.create_api: gapic_v1.method.wrap_method( - self.create_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_api: gapic_v1.method.wrap_method( - self.update_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_api: gapic_v1.method.wrap_method( - self.delete_api, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.list_api_configs: gapic_v1.method.wrap_method( - self.list_api_configs, - default_timeout=None, - client_info=client_info, - ), - self.get_api_config: gapic_v1.method.wrap_method( - self.get_api_config, - default_timeout=None, - client_info=client_info, - ), - self.create_api_config: gapic_v1.method.wrap_method( - self.create_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.update_api_config: gapic_v1.method.wrap_method( - self.update_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_api_config: gapic_v1.method.wrap_method( - self.delete_api_config, - default_retry=retries.Retry( -initial=1.0,maximum=60.0,multiplier=2, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - core_exceptions.Unknown, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - } - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def list_gateways(self) -> Callable[ - [apigateway.ListGatewaysRequest], - Union[ - apigateway.ListGatewaysResponse, - Awaitable[apigateway.ListGatewaysResponse] - ]]: - raise NotImplementedError() - - @property - def get_gateway(self) -> Callable[ - [apigateway.GetGatewayRequest], - Union[ - apigateway.Gateway, - Awaitable[apigateway.Gateway] - ]]: - raise NotImplementedError() - - @property - def create_gateway(self) -> Callable[ - [apigateway.CreateGatewayRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def update_gateway(self) -> Callable[ - [apigateway.UpdateGatewayRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def delete_gateway(self) -> Callable[ - [apigateway.DeleteGatewayRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_apis(self) -> Callable[ - [apigateway.ListApisRequest], - Union[ - apigateway.ListApisResponse, - Awaitable[apigateway.ListApisResponse] - ]]: - raise NotImplementedError() - - @property - def get_api(self) -> Callable[ - [apigateway.GetApiRequest], - Union[ - apigateway.Api, - Awaitable[apigateway.Api] - ]]: - raise NotImplementedError() - - @property - def create_api(self) -> Callable[ - [apigateway.CreateApiRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def update_api(self) -> Callable[ - [apigateway.UpdateApiRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def delete_api(self) -> Callable[ - [apigateway.DeleteApiRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_api_configs(self) -> Callable[ - [apigateway.ListApiConfigsRequest], - Union[ - apigateway.ListApiConfigsResponse, - Awaitable[apigateway.ListApiConfigsResponse] - ]]: - raise NotImplementedError() - - @property - def get_api_config(self) -> Callable[ - [apigateway.GetApiConfigRequest], - Union[ - apigateway.ApiConfig, - Awaitable[apigateway.ApiConfig] - ]]: - raise NotImplementedError() - - @property - def create_api_config(self) -> Callable[ - [apigateway.CreateApiConfigRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def update_api_config(self) -> Callable[ - [apigateway.UpdateApiConfigRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def delete_api_config(self) -> Callable[ - [apigateway.DeleteApiConfigRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'ApiGatewayServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py deleted file mode 100644 index 6902f5d..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc.py +++ /dev/null @@ -1,638 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.api_core import gapic_v1 # type: ignore -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.apigateway_v1.types import apigateway -from google.longrunning import operations_pb2 # type: ignore -from .base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO - - -class ApiGatewayServiceGrpcTransport(ApiGatewayServiceTransport): - """gRPC backend transport for ApiGatewayService. - - The API Gateway Service is the interface for managing API - Gateways. - - 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 = 'apigateway.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'apigateway.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Sanity check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def list_gateways(self) -> Callable[ - [apigateway.ListGatewaysRequest], - apigateway.ListGatewaysResponse]: - r"""Return a callable for the list gateways method over gRPC. - - Lists Gateways in a given project and location. - - Returns: - Callable[[~.ListGatewaysRequest], - ~.ListGatewaysResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_gateways' not in self._stubs: - self._stubs['list_gateways'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListGateways', - request_serializer=apigateway.ListGatewaysRequest.serialize, - response_deserializer=apigateway.ListGatewaysResponse.deserialize, - ) - return self._stubs['list_gateways'] - - @property - def get_gateway(self) -> Callable[ - [apigateway.GetGatewayRequest], - apigateway.Gateway]: - r"""Return a callable for the get gateway method over gRPC. - - Gets details of a single Gateway. - - Returns: - Callable[[~.GetGatewayRequest], - ~.Gateway]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_gateway' not in self._stubs: - self._stubs['get_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetGateway', - request_serializer=apigateway.GetGatewayRequest.serialize, - response_deserializer=apigateway.Gateway.deserialize, - ) - return self._stubs['get_gateway'] - - @property - def create_gateway(self) -> Callable[ - [apigateway.CreateGatewayRequest], - operations_pb2.Operation]: - r"""Return a callable for the create gateway method over gRPC. - - Creates a new Gateway in a given project and - location. - - Returns: - Callable[[~.CreateGatewayRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_gateway' not in self._stubs: - self._stubs['create_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway', - request_serializer=apigateway.CreateGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_gateway'] - - @property - def update_gateway(self) -> Callable[ - [apigateway.UpdateGatewayRequest], - operations_pb2.Operation]: - r"""Return a callable for the update gateway method over gRPC. - - Updates the parameters of a single Gateway. - - Returns: - Callable[[~.UpdateGatewayRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_gateway' not in self._stubs: - self._stubs['update_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway', - request_serializer=apigateway.UpdateGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_gateway'] - - @property - def delete_gateway(self) -> Callable[ - [apigateway.DeleteGatewayRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete gateway method over gRPC. - - Deletes a single Gateway. - - Returns: - Callable[[~.DeleteGatewayRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_gateway' not in self._stubs: - self._stubs['delete_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway', - request_serializer=apigateway.DeleteGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_gateway'] - - @property - def list_apis(self) -> Callable[ - [apigateway.ListApisRequest], - apigateway.ListApisResponse]: - r"""Return a callable for the list apis method over gRPC. - - Lists Apis in a given project and location. - - Returns: - Callable[[~.ListApisRequest], - ~.ListApisResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_apis' not in self._stubs: - self._stubs['list_apis'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListApis', - request_serializer=apigateway.ListApisRequest.serialize, - response_deserializer=apigateway.ListApisResponse.deserialize, - ) - return self._stubs['list_apis'] - - @property - def get_api(self) -> Callable[ - [apigateway.GetApiRequest], - apigateway.Api]: - r"""Return a callable for the get api method over gRPC. - - Gets details of a single Api. - - Returns: - Callable[[~.GetApiRequest], - ~.Api]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_api' not in self._stubs: - self._stubs['get_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetApi', - request_serializer=apigateway.GetApiRequest.serialize, - response_deserializer=apigateway.Api.deserialize, - ) - return self._stubs['get_api'] - - @property - def create_api(self) -> Callable[ - [apigateway.CreateApiRequest], - operations_pb2.Operation]: - r"""Return a callable for the create api method over gRPC. - - Creates a new Api in a given project and location. - - Returns: - Callable[[~.CreateApiRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_api' not in self._stubs: - self._stubs['create_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateApi', - request_serializer=apigateway.CreateApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_api'] - - @property - def update_api(self) -> Callable[ - [apigateway.UpdateApiRequest], - operations_pb2.Operation]: - r"""Return a callable for the update api method over gRPC. - - Updates the parameters of a single Api. - - Returns: - Callable[[~.UpdateApiRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_api' not in self._stubs: - self._stubs['update_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi', - request_serializer=apigateway.UpdateApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_api'] - - @property - def delete_api(self) -> Callable[ - [apigateway.DeleteApiRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete api method over gRPC. - - Deletes a single Api. - - Returns: - Callable[[~.DeleteApiRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_api' not in self._stubs: - self._stubs['delete_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi', - request_serializer=apigateway.DeleteApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_api'] - - @property - def list_api_configs(self) -> Callable[ - [apigateway.ListApiConfigsRequest], - apigateway.ListApiConfigsResponse]: - r"""Return a callable for the list api configs method over gRPC. - - Lists ApiConfigs in a given project and location. - - Returns: - Callable[[~.ListApiConfigsRequest], - ~.ListApiConfigsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_api_configs' not in self._stubs: - self._stubs['list_api_configs'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs', - request_serializer=apigateway.ListApiConfigsRequest.serialize, - response_deserializer=apigateway.ListApiConfigsResponse.deserialize, - ) - return self._stubs['list_api_configs'] - - @property - def get_api_config(self) -> Callable[ - [apigateway.GetApiConfigRequest], - apigateway.ApiConfig]: - r"""Return a callable for the get api config method over gRPC. - - Gets details of a single ApiConfig. - - Returns: - Callable[[~.GetApiConfigRequest], - ~.ApiConfig]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_api_config' not in self._stubs: - self._stubs['get_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig', - request_serializer=apigateway.GetApiConfigRequest.serialize, - response_deserializer=apigateway.ApiConfig.deserialize, - ) - return self._stubs['get_api_config'] - - @property - def create_api_config(self) -> Callable[ - [apigateway.CreateApiConfigRequest], - operations_pb2.Operation]: - r"""Return a callable for the create api config method over gRPC. - - Creates a new ApiConfig in a given project and - location. - - Returns: - Callable[[~.CreateApiConfigRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_api_config' not in self._stubs: - self._stubs['create_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig', - request_serializer=apigateway.CreateApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_api_config'] - - @property - def update_api_config(self) -> Callable[ - [apigateway.UpdateApiConfigRequest], - operations_pb2.Operation]: - r"""Return a callable for the update api config method over gRPC. - - Updates the parameters of a single ApiConfig. - - Returns: - Callable[[~.UpdateApiConfigRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_api_config' not in self._stubs: - self._stubs['update_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig', - request_serializer=apigateway.UpdateApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_api_config'] - - @property - def delete_api_config(self) -> Callable[ - [apigateway.DeleteApiConfigRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete api config method over gRPC. - - Deletes a single ApiConfig. - - Returns: - Callable[[~.DeleteApiConfigRequest], - ~.Operation]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_api_config' not in self._stubs: - self._stubs['delete_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig', - request_serializer=apigateway.DeleteApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_api_config'] - - -__all__ = ( - 'ApiGatewayServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py deleted file mode 100644 index 7d067dd..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/services/api_gateway_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,642 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.apigateway_v1.types import apigateway -from google.longrunning import operations_pb2 # type: ignore -from .base import ApiGatewayServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import ApiGatewayServiceGrpcTransport - - -class ApiGatewayServiceGrpcAsyncIOTransport(ApiGatewayServiceTransport): - """gRPC AsyncIO backend transport for ApiGatewayService. - - The API Gateway Service is the interface for managing API - Gateways. - - 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 = 'apigateway.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'apigateway.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - self._operations_client = None - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def operations_client(self) -> operations_v1.OperationsAsyncClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Sanity check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsAsyncClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def list_gateways(self) -> Callable[ - [apigateway.ListGatewaysRequest], - Awaitable[apigateway.ListGatewaysResponse]]: - r"""Return a callable for the list gateways method over gRPC. - - Lists Gateways in a given project and location. - - Returns: - Callable[[~.ListGatewaysRequest], - Awaitable[~.ListGatewaysResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_gateways' not in self._stubs: - self._stubs['list_gateways'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListGateways', - request_serializer=apigateway.ListGatewaysRequest.serialize, - response_deserializer=apigateway.ListGatewaysResponse.deserialize, - ) - return self._stubs['list_gateways'] - - @property - def get_gateway(self) -> Callable[ - [apigateway.GetGatewayRequest], - Awaitable[apigateway.Gateway]]: - r"""Return a callable for the get gateway method over gRPC. - - Gets details of a single Gateway. - - Returns: - Callable[[~.GetGatewayRequest], - Awaitable[~.Gateway]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_gateway' not in self._stubs: - self._stubs['get_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetGateway', - request_serializer=apigateway.GetGatewayRequest.serialize, - response_deserializer=apigateway.Gateway.deserialize, - ) - return self._stubs['get_gateway'] - - @property - def create_gateway(self) -> Callable[ - [apigateway.CreateGatewayRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the create gateway method over gRPC. - - Creates a new Gateway in a given project and - location. - - Returns: - Callable[[~.CreateGatewayRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_gateway' not in self._stubs: - self._stubs['create_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway', - request_serializer=apigateway.CreateGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_gateway'] - - @property - def update_gateway(self) -> Callable[ - [apigateway.UpdateGatewayRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the update gateway method over gRPC. - - Updates the parameters of a single Gateway. - - Returns: - Callable[[~.UpdateGatewayRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_gateway' not in self._stubs: - self._stubs['update_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway', - request_serializer=apigateway.UpdateGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_gateway'] - - @property - def delete_gateway(self) -> Callable[ - [apigateway.DeleteGatewayRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete gateway method over gRPC. - - Deletes a single Gateway. - - Returns: - Callable[[~.DeleteGatewayRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_gateway' not in self._stubs: - self._stubs['delete_gateway'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway', - request_serializer=apigateway.DeleteGatewayRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_gateway'] - - @property - def list_apis(self) -> Callable[ - [apigateway.ListApisRequest], - Awaitable[apigateway.ListApisResponse]]: - r"""Return a callable for the list apis method over gRPC. - - Lists Apis in a given project and location. - - Returns: - Callable[[~.ListApisRequest], - Awaitable[~.ListApisResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_apis' not in self._stubs: - self._stubs['list_apis'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListApis', - request_serializer=apigateway.ListApisRequest.serialize, - response_deserializer=apigateway.ListApisResponse.deserialize, - ) - return self._stubs['list_apis'] - - @property - def get_api(self) -> Callable[ - [apigateway.GetApiRequest], - Awaitable[apigateway.Api]]: - r"""Return a callable for the get api method over gRPC. - - Gets details of a single Api. - - Returns: - Callable[[~.GetApiRequest], - Awaitable[~.Api]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_api' not in self._stubs: - self._stubs['get_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetApi', - request_serializer=apigateway.GetApiRequest.serialize, - response_deserializer=apigateway.Api.deserialize, - ) - return self._stubs['get_api'] - - @property - def create_api(self) -> Callable[ - [apigateway.CreateApiRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the create api method over gRPC. - - Creates a new Api in a given project and location. - - Returns: - Callable[[~.CreateApiRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_api' not in self._stubs: - self._stubs['create_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateApi', - request_serializer=apigateway.CreateApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_api'] - - @property - def update_api(self) -> Callable[ - [apigateway.UpdateApiRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the update api method over gRPC. - - Updates the parameters of a single Api. - - Returns: - Callable[[~.UpdateApiRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_api' not in self._stubs: - self._stubs['update_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi', - request_serializer=apigateway.UpdateApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_api'] - - @property - def delete_api(self) -> Callable[ - [apigateway.DeleteApiRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete api method over gRPC. - - Deletes a single Api. - - Returns: - Callable[[~.DeleteApiRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_api' not in self._stubs: - self._stubs['delete_api'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi', - request_serializer=apigateway.DeleteApiRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_api'] - - @property - def list_api_configs(self) -> Callable[ - [apigateway.ListApiConfigsRequest], - Awaitable[apigateway.ListApiConfigsResponse]]: - r"""Return a callable for the list api configs method over gRPC. - - Lists ApiConfigs in a given project and location. - - Returns: - Callable[[~.ListApiConfigsRequest], - Awaitable[~.ListApiConfigsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_api_configs' not in self._stubs: - self._stubs['list_api_configs'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs', - request_serializer=apigateway.ListApiConfigsRequest.serialize, - response_deserializer=apigateway.ListApiConfigsResponse.deserialize, - ) - return self._stubs['list_api_configs'] - - @property - def get_api_config(self) -> Callable[ - [apigateway.GetApiConfigRequest], - Awaitable[apigateway.ApiConfig]]: - r"""Return a callable for the get api config method over gRPC. - - Gets details of a single ApiConfig. - - Returns: - Callable[[~.GetApiConfigRequest], - Awaitable[~.ApiConfig]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_api_config' not in self._stubs: - self._stubs['get_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig', - request_serializer=apigateway.GetApiConfigRequest.serialize, - response_deserializer=apigateway.ApiConfig.deserialize, - ) - return self._stubs['get_api_config'] - - @property - def create_api_config(self) -> Callable[ - [apigateway.CreateApiConfigRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the create api config method over gRPC. - - Creates a new ApiConfig in a given project and - location. - - Returns: - Callable[[~.CreateApiConfigRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_api_config' not in self._stubs: - self._stubs['create_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig', - request_serializer=apigateway.CreateApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_api_config'] - - @property - def update_api_config(self) -> Callable[ - [apigateway.UpdateApiConfigRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the update api config method over gRPC. - - Updates the parameters of a single ApiConfig. - - Returns: - Callable[[~.UpdateApiConfigRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_api_config' not in self._stubs: - self._stubs['update_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig', - request_serializer=apigateway.UpdateApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['update_api_config'] - - @property - def delete_api_config(self) -> Callable[ - [apigateway.DeleteApiConfigRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete api config method over gRPC. - - Deletes a single ApiConfig. - - Returns: - Callable[[~.DeleteApiConfigRequest], - Awaitable[~.Operation]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_api_config' not in self._stubs: - self._stubs['delete_api_config'] = self.grpc_channel.unary_unary( - '/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig', - request_serializer=apigateway.DeleteApiConfigRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_api_config'] - - -__all__ = ( - 'ApiGatewayServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py deleted file mode 100644 index d11ff3a..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/__init__.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .apigateway import ( - Api, - ApiConfig, - CreateApiConfigRequest, - CreateApiRequest, - CreateGatewayRequest, - DeleteApiConfigRequest, - DeleteApiRequest, - DeleteGatewayRequest, - Gateway, - GetApiConfigRequest, - GetApiRequest, - GetGatewayRequest, - ListApiConfigsRequest, - ListApiConfigsResponse, - ListApisRequest, - ListApisResponse, - ListGatewaysRequest, - ListGatewaysResponse, - OperationMetadata, - UpdateApiConfigRequest, - UpdateApiRequest, - UpdateGatewayRequest, -) - -__all__ = ( - 'Api', - 'ApiConfig', - 'CreateApiConfigRequest', - 'CreateApiRequest', - 'CreateGatewayRequest', - 'DeleteApiConfigRequest', - 'DeleteApiRequest', - 'DeleteGatewayRequest', - 'Gateway', - 'GetApiConfigRequest', - 'GetApiRequest', - 'GetGatewayRequest', - 'ListApiConfigsRequest', - 'ListApiConfigsResponse', - 'ListApisRequest', - 'ListApisResponse', - 'ListGatewaysRequest', - 'ListGatewaysResponse', - 'OperationMetadata', - 'UpdateApiConfigRequest', - 'UpdateApiRequest', - 'UpdateGatewayRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py deleted file mode 100644 index 5f82895..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway.py +++ /dev/null @@ -1,941 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import proto # type: ignore - -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.apigateway.v1', - manifest={ - 'Api', - 'ApiConfig', - 'Gateway', - 'ListGatewaysRequest', - 'ListGatewaysResponse', - 'GetGatewayRequest', - 'CreateGatewayRequest', - 'UpdateGatewayRequest', - 'DeleteGatewayRequest', - 'ListApisRequest', - 'ListApisResponse', - 'GetApiRequest', - 'CreateApiRequest', - 'UpdateApiRequest', - 'DeleteApiRequest', - 'ListApiConfigsRequest', - 'ListApiConfigsResponse', - 'GetApiConfigRequest', - 'CreateApiConfigRequest', - 'UpdateApiConfigRequest', - 'DeleteApiConfigRequest', - 'OperationMetadata', - }, -) - - -class Api(proto.Message): - r"""An API that can be served by one or more Gateways. - Attributes: - name (str): - Output only. Resource name of the API. - Format: - projects/{project}/locations/global/apis/{api} - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Created time. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Updated time. - labels (Sequence[google.cloud.apigateway_v1.types.Api.LabelsEntry]): - Optional. Resource labels to represent user- - rovided metadata. Refer to cloud documentation - on labels for more details. - https://cloud.google.com/compute/docs/labeling- - resources - display_name (str): - Optional. Display name. - managed_service (str): - Optional. Immutable. The name of a Google - Managed Service ( - https://cloud.google.com/service- - infrastructure/docs/glossary#managed). If not - specified, a new Service will automatically be - created in the same project as this API. - state (google.cloud.apigateway_v1.types.Api.State): - Output only. State of the API. - """ - class State(proto.Enum): - r"""All the possible API states.""" - STATE_UNSPECIFIED = 0 - CREATING = 1 - ACTIVE = 2 - FAILED = 3 - DELETING = 4 - UPDATING = 5 - - name = proto.Field( - proto.STRING, - number=1, - ) - create_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - display_name = proto.Field( - proto.STRING, - number=5, - ) - managed_service = proto.Field( - proto.STRING, - number=7, - ) - state = proto.Field( - proto.ENUM, - number=12, - enum=State, - ) - - -class ApiConfig(proto.Message): - r"""An API Configuration is a combination of settings for both - the Managed Service and Gateways serving this API Config. - - Attributes: - name (str): - Output only. Resource name of the API Config. Format: - projects/{project}/locations/global/apis/{api}/configs/{api_config} - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Created time. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Updated time. - labels (Sequence[google.cloud.apigateway_v1.types.ApiConfig.LabelsEntry]): - Optional. Resource labels to represent user- - rovided metadata. Refer to cloud documentation - on labels for more details. - https://cloud.google.com/compute/docs/labeling- - resources - display_name (str): - Optional. Display name. - gateway_service_account (str): - Immutable. The Google Cloud IAM Service Account that - Gateways serving this config should use to authenticate to - other services. This may either be the Service Account's - email (``{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com``) - or its full resource name - (``projects/{PROJECT}/accounts/{UNIQUE_ID}``). This is most - often used when the service is a GCP resource such as a - Cloud Run Service or an IAP-secured service. - service_config_id (str): - Output only. The ID of the associated Service - Config ( https://cloud.google.com/service- - infrastructure/docs/glossary#config). - state (google.cloud.apigateway_v1.types.ApiConfig.State): - Output only. State of the API Config. - openapi_documents (Sequence[google.cloud.apigateway_v1.types.ApiConfig.OpenApiDocument]): - Optional. OpenAPI specification documents. If specified, - grpc_services and managed_service_configs must not be - included. - grpc_services (Sequence[google.cloud.apigateway_v1.types.ApiConfig.GrpcServiceDefinition]): - Optional. gRPC service definition files. If specified, - openapi_documents must not be included. - managed_service_configs (Sequence[google.cloud.apigateway_v1.types.ApiConfig.File]): - Optional. Service Configuration files. At least one must be - included when using gRPC service definitions. See - https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview - for the expected file contents. - - If multiple files are specified, the files are merged with - the following rules: - - - All singular scalar fields are merged using "last one - wins" semantics in the order of the files uploaded. - - Repeated fields are concatenated. - - Singular embedded messages are merged using these rules - for nested fields. - """ - class State(proto.Enum): - r"""All the possible API Config states.""" - STATE_UNSPECIFIED = 0 - CREATING = 1 - ACTIVE = 2 - FAILED = 3 - DELETING = 4 - UPDATING = 5 - ACTIVATING = 6 - - class File(proto.Message): - r"""A lightweight description of a file. - Attributes: - path (str): - The file path (full or relative path). This - is typically the path of the file when it is - uploaded. - contents (bytes): - The bytes that constitute the file. - """ - - path = proto.Field( - proto.STRING, - number=1, - ) - contents = proto.Field( - proto.BYTES, - number=2, - ) - - class OpenApiDocument(proto.Message): - r"""An OpenAPI Specification Document describing an API. - Attributes: - document (google.cloud.apigateway_v1.types.ApiConfig.File): - The OpenAPI Specification document file. - """ - - document = proto.Field( - proto.MESSAGE, - number=1, - message='ApiConfig.File', - ) - - class GrpcServiceDefinition(proto.Message): - r"""A gRPC service definition. - Attributes: - file_descriptor_set (google.cloud.apigateway_v1.types.ApiConfig.File): - Input only. File descriptor set, generated by protoc. - - To generate, use protoc with imports and source info - included. For an example test.proto file, the following - command would put the value in a new file named out.pb. - - $ protoc --include_imports --include_source_info test.proto - -o out.pb - source (Sequence[google.cloud.apigateway_v1.types.ApiConfig.File]): - Optional. Uncompiled proto files associated with the - descriptor set, used for display purposes (server-side - compilation is not supported). These should match the inputs - to 'protoc' command used to generate file_descriptor_set. - """ - - file_descriptor_set = proto.Field( - proto.MESSAGE, - number=1, - message='ApiConfig.File', - ) - source = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='ApiConfig.File', - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - create_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - display_name = proto.Field( - proto.STRING, - number=5, - ) - gateway_service_account = proto.Field( - proto.STRING, - number=14, - ) - service_config_id = proto.Field( - proto.STRING, - number=12, - ) - state = proto.Field( - proto.ENUM, - number=8, - enum=State, - ) - openapi_documents = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=OpenApiDocument, - ) - grpc_services = proto.RepeatedField( - proto.MESSAGE, - number=10, - message=GrpcServiceDefinition, - ) - managed_service_configs = proto.RepeatedField( - proto.MESSAGE, - number=11, - message=File, - ) - - -class Gateway(proto.Message): - r"""A Gateway is an API-aware HTTP proxy. It performs API-Method - and/or API-Consumer specific actions based on an API Config such - as authentication, policy enforcement, and backend selection. - - Attributes: - name (str): - Output only. Resource name of the Gateway. - Format: - projects/{project}/locations/{location}/gateways/{gateway} - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Created time. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Updated time. - labels (Sequence[google.cloud.apigateway_v1.types.Gateway.LabelsEntry]): - Optional. Resource labels to represent user- - rovided metadata. Refer to cloud documentation - on labels for more details. - https://cloud.google.com/compute/docs/labeling- - resources - display_name (str): - Optional. Display name. - api_config (str): - Required. Resource name of the API Config for - this Gateway. Format: - projects/{project}/locations/global/apis/{api}/configs/{apiConfig} - state (google.cloud.apigateway_v1.types.Gateway.State): - Output only. The current state of the - Gateway. - default_hostname (str): - Output only. The default API Gateway host name of the form - ``{gateway_id}-{hash}.{region_code}.gateway.dev``. - """ - class State(proto.Enum): - r"""All the possible Gateway states.""" - STATE_UNSPECIFIED = 0 - CREATING = 1 - ACTIVE = 2 - FAILED = 3 - DELETING = 4 - UPDATING = 5 - - name = proto.Field( - proto.STRING, - number=1, - ) - create_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - display_name = proto.Field( - proto.STRING, - number=5, - ) - api_config = proto.Field( - proto.STRING, - number=6, - ) - state = proto.Field( - proto.ENUM, - number=7, - enum=State, - ) - default_hostname = proto.Field( - proto.STRING, - number=9, - ) - - -class ListGatewaysRequest(proto.Message): - r"""Request message for ApiGatewayService.ListGateways - Attributes: - parent (str): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - page_size (int): - Page size. - page_token (str): - Page token. - filter (str): - Filter. - order_by (str): - Order by parameters. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - order_by = proto.Field( - proto.STRING, - number=5, - ) - - -class ListGatewaysResponse(proto.Message): - r"""Response message for ApiGatewayService.ListGateways - Attributes: - gateways (Sequence[google.cloud.apigateway_v1.types.Gateway]): - Gateways. - next_page_token (str): - Next page token. - unreachable_locations (Sequence[str]): - Locations that could not be reached. - """ - - @property - def raw_page(self): - return self - - gateways = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Gateway', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - unreachable_locations = proto.RepeatedField( - proto.STRING, - number=3, - ) - - -class GetGatewayRequest(proto.Message): - r"""Request message for ApiGatewayService.GetGateway - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class CreateGatewayRequest(proto.Message): - r"""Request message for ApiGatewayService.CreateGateway - Attributes: - parent (str): - Required. Parent resource of the Gateway, of the form: - ``projects/*/locations/*`` - gateway_id (str): - Required. Identifier to assign to the - Gateway. Must be unique within scope of the - parent resource. - gateway (google.cloud.apigateway_v1.types.Gateway): - Required. Gateway resource. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - gateway_id = proto.Field( - proto.STRING, - number=2, - ) - gateway = proto.Field( - proto.MESSAGE, - number=3, - message='Gateway', - ) - - -class UpdateGatewayRequest(proto.Message): - r"""Request message for ApiGatewayService.UpdateGateway - Attributes: - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be overwritten - in the Gateway resource by the update. The fields specified - in the update_mask are relative to the resource, not the - full request. A field will be overwritten if it is in the - mask. If the user does not provide a mask then all fields - will be overwritten. - gateway (google.cloud.apigateway_v1.types.Gateway): - Required. Gateway resource. - """ - - update_mask = proto.Field( - proto.MESSAGE, - number=1, - message=field_mask_pb2.FieldMask, - ) - gateway = proto.Field( - proto.MESSAGE, - number=2, - message='Gateway', - ) - - -class DeleteGatewayRequest(proto.Message): - r"""Request message for ApiGatewayService.DeleteGateway - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/*/gateways/*`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class ListApisRequest(proto.Message): - r"""Request message for ApiGatewayService.ListApis - Attributes: - parent (str): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - page_size (int): - Page size. - page_token (str): - Page token. - filter (str): - Filter. - order_by (str): - Order by parameters. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - order_by = proto.Field( - proto.STRING, - number=5, - ) - - -class ListApisResponse(proto.Message): - r"""Response message for ApiGatewayService.ListApis - Attributes: - apis (Sequence[google.cloud.apigateway_v1.types.Api]): - APIs. - next_page_token (str): - Next page token. - unreachable_locations (Sequence[str]): - Locations that could not be reached. - """ - - @property - def raw_page(self): - return self - - apis = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Api', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - unreachable_locations = proto.RepeatedField( - proto.STRING, - number=3, - ) - - -class GetApiRequest(proto.Message): - r"""Request message for ApiGatewayService.GetApi - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class CreateApiRequest(proto.Message): - r"""Request message for ApiGatewayService.CreateApi - Attributes: - parent (str): - Required. Parent resource of the API, of the form: - ``projects/*/locations/global`` - api_id (str): - Required. Identifier to assign to the API. - Must be unique within scope of the parent - resource. - api (google.cloud.apigateway_v1.types.Api): - Required. API resource. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - api_id = proto.Field( - proto.STRING, - number=2, - ) - api = proto.Field( - proto.MESSAGE, - number=3, - message='Api', - ) - - -class UpdateApiRequest(proto.Message): - r"""Request message for ApiGatewayService.UpdateApi - Attributes: - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be overwritten - in the Api resource by the update. The fields specified in - the update_mask are relative to the resource, not the full - request. A field will be overwritten if it is in the mask. - If the user does not provide a mask then all fields will be - overwritten. - api (google.cloud.apigateway_v1.types.Api): - Required. API resource. - """ - - update_mask = proto.Field( - proto.MESSAGE, - number=1, - message=field_mask_pb2.FieldMask, - ) - api = proto.Field( - proto.MESSAGE, - number=2, - message='Api', - ) - - -class DeleteApiRequest(proto.Message): - r"""Request message for ApiGatewayService.DeleteApi - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class ListApiConfigsRequest(proto.Message): - r"""Request message for ApiGatewayService.ListApiConfigs - Attributes: - parent (str): - Required. Parent resource of the API Config, of the form: - ``projects/*/locations/global/apis/*`` - page_size (int): - Page size. - page_token (str): - Page token. - filter (str): - Filter. - order_by (str): - Order by parameters. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - filter = proto.Field( - proto.STRING, - number=4, - ) - order_by = proto.Field( - proto.STRING, - number=5, - ) - - -class ListApiConfigsResponse(proto.Message): - r"""Response message for ApiGatewayService.ListApiConfigs - Attributes: - api_configs (Sequence[google.cloud.apigateway_v1.types.ApiConfig]): - API Configs. - next_page_token (str): - Next page token. - unreachable_locations (Sequence[str]): - Locations that could not be reached. - """ - - @property - def raw_page(self): - return self - - api_configs = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='ApiConfig', - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - unreachable_locations = proto.RepeatedField( - proto.STRING, - number=3, - ) - - -class GetApiConfigRequest(proto.Message): - r"""Request message for ApiGatewayService.GetApiConfig - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - view (google.cloud.apigateway_v1.types.GetApiConfigRequest.ConfigView): - Specifies which fields of the API Config are returned in the - response. Defaults to ``BASIC`` view. - """ - class ConfigView(proto.Enum): - r"""Enum to control which fields should be included in the - response. - """ - CONFIG_VIEW_UNSPECIFIED = 0 - BASIC = 1 - FULL = 2 - - name = proto.Field( - proto.STRING, - number=1, - ) - view = proto.Field( - proto.ENUM, - number=3, - enum=ConfigView, - ) - - -class CreateApiConfigRequest(proto.Message): - r"""Request message for ApiGatewayService.CreateApiConfig - Attributes: - parent (str): - Required. Parent resource of the API Config, of the form: - ``projects/*/locations/global/apis/*`` - api_config_id (str): - Required. Identifier to assign to the API - Config. Must be unique within scope of the - parent resource. - api_config (google.cloud.apigateway_v1.types.ApiConfig): - Required. API resource. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - api_config_id = proto.Field( - proto.STRING, - number=2, - ) - api_config = proto.Field( - proto.MESSAGE, - number=3, - message='ApiConfig', - ) - - -class UpdateApiConfigRequest(proto.Message): - r"""Request message for ApiGatewayService.UpdateApiConfig - Attributes: - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Field mask is used to specify the fields to be overwritten - in the ApiConfig resource by the update. The fields - specified in the update_mask are relative to the resource, - not the full request. A field will be overwritten if it is - in the mask. If the user does not provide a mask then all - fields will be overwritten. - api_config (google.cloud.apigateway_v1.types.ApiConfig): - Required. API Config resource. - """ - - update_mask = proto.Field( - proto.MESSAGE, - number=1, - message=field_mask_pb2.FieldMask, - ) - api_config = proto.Field( - proto.MESSAGE, - number=2, - message='ApiConfig', - ) - - -class DeleteApiConfigRequest(proto.Message): - r"""Request message for ApiGatewayService.DeleteApiConfig - Attributes: - name (str): - Required. Resource name of the form: - ``projects/*/locations/global/apis/*/configs/*`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class OperationMetadata(proto.Message): - r"""Represents the metadata of the long-running operation. - Attributes: - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time the operation was - created. - end_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time the operation finished - running. - target (str): - Output only. Server-defined resource path for - the target of the operation. - verb (str): - Output only. Name of the verb executed by the - operation. - status_message (str): - Output only. Human-readable status of the - operation, if any. - requested_cancellation (bool): - Output only. Identifies whether the user has requested - cancellation of the operation. Operations that have - successfully been cancelled have [Operation.error][] value - with a [google.rpc.Status.code][google.rpc.Status.code] of - 1, corresponding to ``Code.CANCELLED``. - api_version (str): - Output only. API version used to start the - operation. - diagnostics (Sequence[google.cloud.apigateway_v1.types.OperationMetadata.Diagnostic]): - Output only. Diagnostics generated during - processing of configuration source files. - """ - - class Diagnostic(proto.Message): - r"""Diagnostic information from configuration processing. - Attributes: - location (str): - Location of the diagnostic. - message (str): - The diagnostic message. - """ - - location = proto.Field( - proto.STRING, - number=1, - ) - message = proto.Field( - proto.STRING, - number=2, - ) - - create_time = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - end_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - target = proto.Field( - proto.STRING, - number=3, - ) - verb = proto.Field( - proto.STRING, - number=4, - ) - status_message = proto.Field( - proto.STRING, - number=5, - ) - requested_cancellation = proto.Field( - proto.BOOL, - number=6, - ) - api_version = proto.Field( - proto.STRING, - number=7, - ) - diagnostics = proto.RepeatedField( - proto.MESSAGE, - number=8, - message=Diagnostic, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py b/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py deleted file mode 100644 index 958c7e3..0000000 --- a/owl-bot-staging/v1/google/cloud/apigateway_v1/types/apigateway_service.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - - -__protobuf__ = proto.module( - package='google.cloud.apigateway.v1', - manifest={ - }, -) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 8d6ee10..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/apigateway_v1/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py deleted file mode 100644 index 893aa60..0000000 --- a/owl-bot-staging/v1/scripts/fixup_apigateway_v1_keywords.py +++ /dev/null @@ -1,190 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class apigatewayCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_api': ('parent', 'api_id', 'api', ), - 'create_api_config': ('parent', 'api_config_id', 'api_config', ), - 'create_gateway': ('parent', 'gateway_id', 'gateway', ), - 'delete_api': ('name', ), - 'delete_api_config': ('name', ), - 'delete_gateway': ('name', ), - 'get_api': ('name', ), - 'get_api_config': ('name', 'view', ), - 'get_gateway': ('name', ), - 'list_api_configs': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), - 'list_apis': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), - 'list_gateways': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), - 'update_api': ('api', 'update_mask', ), - 'update_api_config': ('api_config', 'update_mask', ), - 'update_gateway': ('gateway', 'update_mask', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: not a.keyword.value in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=apigatewayCallTransformer(), -): - """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 apigateway client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index 06369e4..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-api-gateway', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py b/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py deleted file mode 100644 index 69244be..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py +++ /dev/null @@ -1,5205 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import future -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import operation_async # type: ignore -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.apigateway_v1.services.api_gateway_service import ApiGatewayServiceAsyncClient -from google.cloud.apigateway_v1.services.api_gateway_service import ApiGatewayServiceClient -from google.cloud.apigateway_v1.services.api_gateway_service import pagers -from google.cloud.apigateway_v1.services.api_gateway_service import transports -from google.cloud.apigateway_v1.services.api_gateway_service.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.apigateway_v1.types import apigateway -from google.longrunning import operations_pb2 -from google.oauth2 import service_account -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert ApiGatewayServiceClient._get_default_mtls_endpoint(None) is None - assert ApiGatewayServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert ApiGatewayServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert ApiGatewayServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert ApiGatewayServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert ApiGatewayServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - ApiGatewayServiceClient, - ApiGatewayServiceAsyncClient, -]) -def test_api_gateway_service_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'apigateway.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.ApiGatewayServiceGrpcTransport, "grpc"), - (transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_api_gateway_service_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", [ - ApiGatewayServiceClient, - ApiGatewayServiceAsyncClient, -]) -def test_api_gateway_service_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'apigateway.googleapis.com:443' - - -def test_api_gateway_service_client_get_transport_class(): - transport = ApiGatewayServiceClient.get_transport_class() - available_transports = [ - transports.ApiGatewayServiceGrpcTransport, - ] - assert transport in available_transports - - transport = ApiGatewayServiceClient.get_transport_class("grpc") - assert transport == transports.ApiGatewayServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), - (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(ApiGatewayServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceClient)) -@mock.patch.object(ApiGatewayServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceAsyncClient)) -def test_api_gateway_service_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(ApiGatewayServiceClient, '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(ApiGatewayServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc", "true"), - (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc", "false"), - (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(ApiGatewayServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceClient)) -@mock.patch.object(ApiGatewayServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ApiGatewayServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_api_gateway_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), - (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_api_gateway_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ApiGatewayServiceClient, transports.ApiGatewayServiceGrpcTransport, "grpc"), - (ApiGatewayServiceAsyncClient, transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_api_gateway_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_api_gateway_service_client_client_options_from_dict(): - with mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = ApiGatewayServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -def test_list_gateways(transport: str = 'grpc', request_type=apigateway.ListGatewaysRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListGatewaysResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - ) - response = client.list_gateways(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListGatewaysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGatewaysPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -def test_list_gateways_from_dict(): - test_list_gateways(request_type=dict) - - -def test_list_gateways_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - client.list_gateways() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListGatewaysRequest() - - -@pytest.mark.asyncio -async def test_list_gateways_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListGatewaysRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - )) - response = await client.list_gateways(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListGatewaysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGatewaysAsyncPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -@pytest.mark.asyncio -async def test_list_gateways_async_from_dict(): - await test_list_gateways_async(request_type=dict) - - -def test_list_gateways_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.ListGatewaysRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - call.return_value = apigateway.ListGatewaysResponse() - client.list_gateways(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_gateways_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.ListGatewaysRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse()) - await client.list_gateways(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_list_gateways_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListGatewaysResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_gateways( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_gateways_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_gateways( - apigateway.ListGatewaysRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_gateways_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListGatewaysResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListGatewaysResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_gateways( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_gateways_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_gateways( - apigateway.ListGatewaysRequest(), - parent='parent_value', - ) - - -def test_list_gateways_pager(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - apigateway.Gateway(), - ], - next_page_token='abc', - ), - apigateway.ListGatewaysResponse( - gateways=[], - next_page_token='def', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - ], - next_page_token='ghi', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_gateways(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, apigateway.Gateway) - for i in results) - -def test_list_gateways_pages(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - apigateway.Gateway(), - ], - next_page_token='abc', - ), - apigateway.ListGatewaysResponse( - gateways=[], - next_page_token='def', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - ], - next_page_token='ghi', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - ], - ), - RuntimeError, - ) - pages = list(client.list_gateways(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_gateways_async_pager(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - apigateway.Gateway(), - ], - next_page_token='abc', - ), - apigateway.ListGatewaysResponse( - gateways=[], - next_page_token='def', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - ], - next_page_token='ghi', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_gateways(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, apigateway.Gateway) - for i in responses) - -@pytest.mark.asyncio -async def test_list_gateways_async_pages(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_gateways), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - apigateway.Gateway(), - ], - next_page_token='abc', - ), - apigateway.ListGatewaysResponse( - gateways=[], - next_page_token='def', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - ], - next_page_token='ghi', - ), - apigateway.ListGatewaysResponse( - gateways=[ - apigateway.Gateway(), - apigateway.Gateway(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_gateways(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_gateway(transport: str = 'grpc', request_type=apigateway.GetGatewayRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Gateway( - name='name_value', - display_name='display_name_value', - api_config='api_config_value', - state=apigateway.Gateway.State.CREATING, - default_hostname='default_hostname_value', - ) - response = client.get_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.Gateway) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.api_config == 'api_config_value' - assert response.state == apigateway.Gateway.State.CREATING - assert response.default_hostname == 'default_hostname_value' - - -def test_get_gateway_from_dict(): - test_get_gateway(request_type=dict) - - -def test_get_gateway_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - client.get_gateway() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetGatewayRequest() - - -@pytest.mark.asyncio -async def test_get_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetGatewayRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway( - name='name_value', - display_name='display_name_value', - api_config='api_config_value', - state=apigateway.Gateway.State.CREATING, - default_hostname='default_hostname_value', - )) - response = await client.get_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.Gateway) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.api_config == 'api_config_value' - assert response.state == apigateway.Gateway.State.CREATING - assert response.default_hostname == 'default_hostname_value' - - -@pytest.mark.asyncio -async def test_get_gateway_async_from_dict(): - await test_get_gateway_async(request_type=dict) - - -def test_get_gateway_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.GetGatewayRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - call.return_value = apigateway.Gateway() - client.get_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_gateway_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.GetGatewayRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway()) - await client.get_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_get_gateway_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Gateway() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_gateway( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_gateway_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_gateway( - apigateway.GetGatewayRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_gateway_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Gateway() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Gateway()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_gateway( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_gateway_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_gateway( - apigateway.GetGatewayRequest(), - name='name_value', - ) - - -def test_create_gateway(transport: str = 'grpc', request_type=apigateway.CreateGatewayRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.create_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_create_gateway_from_dict(): - test_create_gateway(request_type=dict) - - -def test_create_gateway_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - client.create_gateway() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateGatewayRequest() - - -@pytest.mark.asyncio -async def test_create_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateGatewayRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.create_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_create_gateway_async_from_dict(): - await test_create_gateway_async(request_type=dict) - - -def test_create_gateway_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.CreateGatewayRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.create_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_gateway_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.CreateGatewayRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.create_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_create_gateway_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_gateway( - parent='parent_value', - gateway=apigateway.Gateway(name='name_value'), - gateway_id='gateway_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].gateway == apigateway.Gateway(name='name_value') - assert args[0].gateway_id == 'gateway_id_value' - - -def test_create_gateway_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_gateway( - apigateway.CreateGatewayRequest(), - parent='parent_value', - gateway=apigateway.Gateway(name='name_value'), - gateway_id='gateway_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_gateway_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_gateway( - parent='parent_value', - gateway=apigateway.Gateway(name='name_value'), - gateway_id='gateway_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].gateway == apigateway.Gateway(name='name_value') - assert args[0].gateway_id == 'gateway_id_value' - - -@pytest.mark.asyncio -async def test_create_gateway_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_gateway( - apigateway.CreateGatewayRequest(), - parent='parent_value', - gateway=apigateway.Gateway(name='name_value'), - gateway_id='gateway_id_value', - ) - - -def test_update_gateway(transport: str = 'grpc', request_type=apigateway.UpdateGatewayRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.update_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_update_gateway_from_dict(): - test_update_gateway(request_type=dict) - - -def test_update_gateway_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - client.update_gateway() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateGatewayRequest() - - -@pytest.mark.asyncio -async def test_update_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateGatewayRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.update_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_update_gateway_async_from_dict(): - await test_update_gateway_async(request_type=dict) - - -def test_update_gateway_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.UpdateGatewayRequest() - - request.gateway.name = 'gateway.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.update_gateway(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', - 'gateway.name=gateway.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_gateway_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.UpdateGatewayRequest() - - request.gateway.name = 'gateway.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.update_gateway(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', - 'gateway.name=gateway.name/value', - ) in kw['metadata'] - - -def test_update_gateway_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_gateway( - gateway=apigateway.Gateway(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].gateway == apigateway.Gateway(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_gateway_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_gateway( - apigateway.UpdateGatewayRequest(), - gateway=apigateway.Gateway(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_gateway_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_gateway( - gateway=apigateway.Gateway(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].gateway == apigateway.Gateway(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_gateway_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_gateway( - apigateway.UpdateGatewayRequest(), - gateway=apigateway.Gateway(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_gateway(transport: str = 'grpc', request_type=apigateway.DeleteGatewayRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_gateway_from_dict(): - test_delete_gateway(request_type=dict) - - -def test_delete_gateway_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - client.delete_gateway() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteGatewayRequest() - - -@pytest.mark.asyncio -async def test_delete_gateway_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteGatewayRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteGatewayRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_gateway_async_from_dict(): - await test_delete_gateway_async(request_type=dict) - - -def test_delete_gateway_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.DeleteGatewayRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_gateway_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.DeleteGatewayRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_gateway(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_delete_gateway_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_gateway( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_gateway_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_gateway( - apigateway.DeleteGatewayRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_gateway_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_gateway), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_gateway( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_gateway_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_gateway( - apigateway.DeleteGatewayRequest(), - name='name_value', - ) - - -def test_list_apis(transport: str = 'grpc', request_type=apigateway.ListApisRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApisResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - ) - response = client.list_apis(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApisRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListApisPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -def test_list_apis_from_dict(): - test_list_apis(request_type=dict) - - -def test_list_apis_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - client.list_apis() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApisRequest() - - -@pytest.mark.asyncio -async def test_list_apis_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListApisRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - )) - response = await client.list_apis(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApisRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListApisAsyncPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -@pytest.mark.asyncio -async def test_list_apis_async_from_dict(): - await test_list_apis_async(request_type=dict) - - -def test_list_apis_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.ListApisRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - call.return_value = apigateway.ListApisResponse() - client.list_apis(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_apis_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.ListApisRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse()) - await client.list_apis(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_list_apis_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApisResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_apis( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_apis_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_apis( - apigateway.ListApisRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_apis_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApisResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApisResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_apis( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_apis_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_apis( - apigateway.ListApisRequest(), - parent='parent_value', - ) - - -def test_list_apis_pager(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - apigateway.Api(), - ], - next_page_token='abc', - ), - apigateway.ListApisResponse( - apis=[], - next_page_token='def', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - ], - next_page_token='ghi', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_apis(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, apigateway.Api) - for i in results) - -def test_list_apis_pages(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - apigateway.Api(), - ], - next_page_token='abc', - ), - apigateway.ListApisResponse( - apis=[], - next_page_token='def', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - ], - next_page_token='ghi', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - ], - ), - RuntimeError, - ) - pages = list(client.list_apis(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_apis_async_pager(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - apigateway.Api(), - ], - next_page_token='abc', - ), - apigateway.ListApisResponse( - apis=[], - next_page_token='def', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - ], - next_page_token='ghi', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_apis(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, apigateway.Api) - for i in responses) - -@pytest.mark.asyncio -async def test_list_apis_async_pages(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_apis), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - apigateway.Api(), - ], - next_page_token='abc', - ), - apigateway.ListApisResponse( - apis=[], - next_page_token='def', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - ], - next_page_token='ghi', - ), - apigateway.ListApisResponse( - apis=[ - apigateway.Api(), - apigateway.Api(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_apis(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_api(transport: str = 'grpc', request_type=apigateway.GetApiRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Api( - name='name_value', - display_name='display_name_value', - managed_service='managed_service_value', - state=apigateway.Api.State.CREATING, - ) - response = client.get_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.Api) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.managed_service == 'managed_service_value' - assert response.state == apigateway.Api.State.CREATING - - -def test_get_api_from_dict(): - test_get_api(request_type=dict) - - -def test_get_api_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - client.get_api() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiRequest() - - -@pytest.mark.asyncio -async def test_get_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetApiRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api( - name='name_value', - display_name='display_name_value', - managed_service='managed_service_value', - state=apigateway.Api.State.CREATING, - )) - response = await client.get_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.Api) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.managed_service == 'managed_service_value' - assert response.state == apigateway.Api.State.CREATING - - -@pytest.mark.asyncio -async def test_get_api_async_from_dict(): - await test_get_api_async(request_type=dict) - - -def test_get_api_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.GetApiRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - call.return_value = apigateway.Api() - client.get_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_api_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.GetApiRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api()) - await client.get_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_get_api_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Api() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_api( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_api_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_api( - apigateway.GetApiRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_api_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.Api() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.Api()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_api( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_api_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_api( - apigateway.GetApiRequest(), - name='name_value', - ) - - -def test_create_api(transport: str = 'grpc', request_type=apigateway.CreateApiRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.create_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_create_api_from_dict(): - test_create_api(request_type=dict) - - -def test_create_api_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - client.create_api() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiRequest() - - -@pytest.mark.asyncio -async def test_create_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateApiRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.create_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_create_api_async_from_dict(): - await test_create_api_async(request_type=dict) - - -def test_create_api_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.CreateApiRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.create_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_api_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.CreateApiRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.create_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_create_api_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_api( - parent='parent_value', - api=apigateway.Api(name='name_value'), - api_id='api_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].api == apigateway.Api(name='name_value') - assert args[0].api_id == 'api_id_value' - - -def test_create_api_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_api( - apigateway.CreateApiRequest(), - parent='parent_value', - api=apigateway.Api(name='name_value'), - api_id='api_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_api_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_api( - parent='parent_value', - api=apigateway.Api(name='name_value'), - api_id='api_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].api == apigateway.Api(name='name_value') - assert args[0].api_id == 'api_id_value' - - -@pytest.mark.asyncio -async def test_create_api_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_api( - apigateway.CreateApiRequest(), - parent='parent_value', - api=apigateway.Api(name='name_value'), - api_id='api_id_value', - ) - - -def test_update_api(transport: str = 'grpc', request_type=apigateway.UpdateApiRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.update_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_update_api_from_dict(): - test_update_api(request_type=dict) - - -def test_update_api_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - client.update_api() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiRequest() - - -@pytest.mark.asyncio -async def test_update_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateApiRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.update_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_update_api_async_from_dict(): - await test_update_api_async(request_type=dict) - - -def test_update_api_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.UpdateApiRequest() - - request.api.name = 'api.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.update_api(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', - 'api.name=api.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_api_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.UpdateApiRequest() - - request.api.name = 'api.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.update_api(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', - 'api.name=api.name/value', - ) in kw['metadata'] - - -def test_update_api_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_api( - api=apigateway.Api(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].api == apigateway.Api(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_api_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_api( - apigateway.UpdateApiRequest(), - api=apigateway.Api(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_api_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_api( - api=apigateway.Api(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].api == apigateway.Api(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_api_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_api( - apigateway.UpdateApiRequest(), - api=apigateway.Api(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_api(transport: str = 'grpc', request_type=apigateway.DeleteApiRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_api_from_dict(): - test_delete_api(request_type=dict) - - -def test_delete_api_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - client.delete_api() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiRequest() - - -@pytest.mark.asyncio -async def test_delete_api_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteApiRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_api_async_from_dict(): - await test_delete_api_async(request_type=dict) - - -def test_delete_api_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.DeleteApiRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_api_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.DeleteApiRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_api(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_delete_api_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_api( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_api_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_api( - apigateway.DeleteApiRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_api_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_api( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_api_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_api( - apigateway.DeleteApiRequest(), - name='name_value', - ) - - -def test_list_api_configs(transport: str = 'grpc', request_type=apigateway.ListApiConfigsRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApiConfigsResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - ) - response = client.list_api_configs(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApiConfigsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListApiConfigsPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -def test_list_api_configs_from_dict(): - test_list_api_configs(request_type=dict) - - -def test_list_api_configs_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - client.list_api_configs() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApiConfigsRequest() - - -@pytest.mark.asyncio -async def test_list_api_configs_async(transport: str = 'grpc_asyncio', request_type=apigateway.ListApiConfigsRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse( - next_page_token='next_page_token_value', - unreachable_locations=['unreachable_locations_value'], - )) - response = await client.list_api_configs(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.ListApiConfigsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListApiConfigsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - assert response.unreachable_locations == ['unreachable_locations_value'] - - -@pytest.mark.asyncio -async def test_list_api_configs_async_from_dict(): - await test_list_api_configs_async(request_type=dict) - - -def test_list_api_configs_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.ListApiConfigsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - call.return_value = apigateway.ListApiConfigsResponse() - client.list_api_configs(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_api_configs_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.ListApiConfigsRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse()) - await client.list_api_configs(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_list_api_configs_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApiConfigsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_api_configs( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -def test_list_api_configs_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_api_configs( - apigateway.ListApiConfigsRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_api_configs_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ListApiConfigsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ListApiConfigsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_api_configs( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_api_configs_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_api_configs( - apigateway.ListApiConfigsRequest(), - parent='parent_value', - ) - - -def test_list_api_configs_pager(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - next_page_token='abc', - ), - apigateway.ListApiConfigsResponse( - api_configs=[], - next_page_token='def', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - ], - next_page_token='ghi', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_api_configs(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, apigateway.ApiConfig) - for i in results) - -def test_list_api_configs_pages(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - next_page_token='abc', - ), - apigateway.ListApiConfigsResponse( - api_configs=[], - next_page_token='def', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - ], - next_page_token='ghi', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - ), - RuntimeError, - ) - pages = list(client.list_api_configs(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_api_configs_async_pager(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - next_page_token='abc', - ), - apigateway.ListApiConfigsResponse( - api_configs=[], - next_page_token='def', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - ], - next_page_token='ghi', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_api_configs(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, apigateway.ApiConfig) - for i in responses) - -@pytest.mark.asyncio -async def test_list_api_configs_async_pages(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_api_configs), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - next_page_token='abc', - ), - apigateway.ListApiConfigsResponse( - api_configs=[], - next_page_token='def', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - ], - next_page_token='ghi', - ), - apigateway.ListApiConfigsResponse( - api_configs=[ - apigateway.ApiConfig(), - apigateway.ApiConfig(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_api_configs(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_get_api_config(transport: str = 'grpc', request_type=apigateway.GetApiConfigRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ApiConfig( - name='name_value', - display_name='display_name_value', - gateway_service_account='gateway_service_account_value', - service_config_id='service_config_id_value', - state=apigateway.ApiConfig.State.CREATING, - ) - response = client.get_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.ApiConfig) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.gateway_service_account == 'gateway_service_account_value' - assert response.service_config_id == 'service_config_id_value' - assert response.state == apigateway.ApiConfig.State.CREATING - - -def test_get_api_config_from_dict(): - test_get_api_config(request_type=dict) - - -def test_get_api_config_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - client.get_api_config() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiConfigRequest() - - -@pytest.mark.asyncio -async def test_get_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.GetApiConfigRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig( - name='name_value', - display_name='display_name_value', - gateway_service_account='gateway_service_account_value', - service_config_id='service_config_id_value', - state=apigateway.ApiConfig.State.CREATING, - )) - response = await client.get_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.GetApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, apigateway.ApiConfig) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - assert response.gateway_service_account == 'gateway_service_account_value' - assert response.service_config_id == 'service_config_id_value' - assert response.state == apigateway.ApiConfig.State.CREATING - - -@pytest.mark.asyncio -async def test_get_api_config_async_from_dict(): - await test_get_api_config_async(request_type=dict) - - -def test_get_api_config_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.GetApiConfigRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - call.return_value = apigateway.ApiConfig() - client.get_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_api_config_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.GetApiConfigRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig()) - await client.get_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_get_api_config_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ApiConfig() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_api_config( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_get_api_config_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_api_config( - apigateway.GetApiConfigRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_api_config_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = apigateway.ApiConfig() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(apigateway.ApiConfig()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_api_config( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_api_config_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_api_config( - apigateway.GetApiConfigRequest(), - name='name_value', - ) - - -def test_create_api_config(transport: str = 'grpc', request_type=apigateway.CreateApiConfigRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.create_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_create_api_config_from_dict(): - test_create_api_config(request_type=dict) - - -def test_create_api_config_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - client.create_api_config() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiConfigRequest() - - -@pytest.mark.asyncio -async def test_create_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.CreateApiConfigRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.create_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.CreateApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_create_api_config_async_from_dict(): - await test_create_api_config_async(request_type=dict) - - -def test_create_api_config_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.CreateApiConfigRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.create_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_api_config_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.CreateApiConfigRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.create_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent/value', - ) in kw['metadata'] - - -def test_create_api_config_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_api_config( - parent='parent_value', - api_config=apigateway.ApiConfig(name='name_value'), - api_config_id='api_config_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].api_config == apigateway.ApiConfig(name='name_value') - assert args[0].api_config_id == 'api_config_id_value' - - -def test_create_api_config_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_api_config( - apigateway.CreateApiConfigRequest(), - parent='parent_value', - api_config=apigateway.ApiConfig(name='name_value'), - api_config_id='api_config_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_api_config_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_api_config( - parent='parent_value', - api_config=apigateway.ApiConfig(name='name_value'), - api_config_id='api_config_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].api_config == apigateway.ApiConfig(name='name_value') - assert args[0].api_config_id == 'api_config_id_value' - - -@pytest.mark.asyncio -async def test_create_api_config_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_api_config( - apigateway.CreateApiConfigRequest(), - parent='parent_value', - api_config=apigateway.ApiConfig(name='name_value'), - api_config_id='api_config_id_value', - ) - - -def test_update_api_config(transport: str = 'grpc', request_type=apigateway.UpdateApiConfigRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.update_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_update_api_config_from_dict(): - test_update_api_config(request_type=dict) - - -def test_update_api_config_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - client.update_api_config() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiConfigRequest() - - -@pytest.mark.asyncio -async def test_update_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.UpdateApiConfigRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.update_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.UpdateApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_update_api_config_async_from_dict(): - await test_update_api_config_async(request_type=dict) - - -def test_update_api_config_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.UpdateApiConfigRequest() - - request.api_config.name = 'api_config.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.update_api_config(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', - 'api_config.name=api_config.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_api_config_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.UpdateApiConfigRequest() - - request.api_config.name = 'api_config.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.update_api_config(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', - 'api_config.name=api_config.name/value', - ) in kw['metadata'] - - -def test_update_api_config_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_api_config( - api_config=apigateway.ApiConfig(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].api_config == apigateway.ApiConfig(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_api_config_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_api_config( - apigateway.UpdateApiConfigRequest(), - api_config=apigateway.ApiConfig(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_api_config_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_api_config( - api_config=apigateway.ApiConfig(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].api_config == apigateway.ApiConfig(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_api_config_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_api_config( - apigateway.UpdateApiConfigRequest(), - api_config=apigateway.ApiConfig(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_api_config(transport: str = 'grpc', request_type=apigateway.DeleteApiConfigRequest): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_api_config_from_dict(): - test_delete_api_config(request_type=dict) - - -def test_delete_api_config_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 = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - client.delete_api_config() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiConfigRequest() - - -@pytest.mark.asyncio -async def test_delete_api_config_async(transport: str = 'grpc_asyncio', request_type=apigateway.DeleteApiConfigRequest): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == apigateway.DeleteApiConfigRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_api_config_async_from_dict(): - await test_delete_api_config_async(request_type=dict) - - -def test_delete_api_config_field_headers(): - client = ApiGatewayServiceClient( - 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 = apigateway.DeleteApiConfigRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_api_config_field_headers_async(): - client = ApiGatewayServiceAsyncClient( - 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 = apigateway.DeleteApiConfigRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_api_config(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'name=name/value', - ) in kw['metadata'] - - -def test_delete_api_config_flattened(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_api_config( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -def test_delete_api_config_flattened_error(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_api_config( - apigateway.DeleteApiConfigRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_api_config_flattened_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_api_config), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_api_config( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_api_config_flattened_error_async(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_api_config( - apigateway.DeleteApiConfigRequest(), - name='name_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ApiGatewayServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.ApiGatewayServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ApiGatewayServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.ApiGatewayServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ApiGatewayServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ApiGatewayServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = ApiGatewayServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ApiGatewayServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.ApiGatewayServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.ApiGatewayServiceGrpcTransport, - transports.ApiGatewayServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ApiGatewayServiceGrpcTransport, - ) - -def test_api_gateway_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ApiGatewayServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_api_gateway_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.ApiGatewayServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'list_gateways', - 'get_gateway', - 'create_gateway', - 'update_gateway', - 'delete_gateway', - 'list_apis', - 'get_api', - 'create_api', - 'update_api', - 'delete_api', - 'list_api_configs', - 'get_api_config', - 'create_api_config', - 'update_api_config', - 'delete_api_config', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - -@requires_google_auth_gte_1_25_0 -def test_api_gateway_service_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.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ApiGatewayServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_api_gateway_service_base_transport_with_credentials_file_old_google_auth(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ApiGatewayServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_api_gateway_service_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.apigateway_v1.services.api_gateway_service.transports.ApiGatewayServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ApiGatewayServiceTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_api_gateway_service_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) - ApiGatewayServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_api_gateway_service_auth_adc_old_google_auth(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - ApiGatewayServiceClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.ApiGatewayServiceGrpcTransport, - transports.ApiGatewayServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_api_gateway_service_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.ApiGatewayServiceGrpcTransport, - transports.ApiGatewayServiceGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_api_gateway_service_transport_auth_adc_old_google_auth(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.ApiGatewayServiceGrpcTransport, grpc_helpers), - (transports.ApiGatewayServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_api_gateway_service_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( - "apigateway.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="apigateway.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) -def test_api_gateway_service_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_api_gateway_service_host_no_port(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='apigateway.googleapis.com'), - ) - assert client.transport._host == 'apigateway.googleapis.com:443' - - -def test_api_gateway_service_host_with_port(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='apigateway.googleapis.com:8000'), - ) - assert client.transport._host == 'apigateway.googleapis.com:8000' - -def test_api_gateway_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ApiGatewayServiceGrpcTransport( - 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_api_gateway_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ApiGatewayServiceGrpcAsyncIOTransport( - 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.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) -def test_api_gateway_service_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.ApiGatewayServiceGrpcTransport, transports.ApiGatewayServiceGrpcAsyncIOTransport]) -def test_api_gateway_service_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_api_gateway_service_grpc_lro_client(): - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_api_gateway_service_grpc_lro_async_client(): - client = ApiGatewayServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsAsyncClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_api_path(): - project = "squid" - api = "clam" - expected = "projects/{project}/locations/global/apis/{api}".format(project=project, api=api, ) - actual = ApiGatewayServiceClient.api_path(project, api) - assert expected == actual - - -def test_parse_api_path(): - expected = { - "project": "whelk", - "api": "octopus", - } - path = ApiGatewayServiceClient.api_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_api_path(path) - assert expected == actual - -def test_api_config_path(): - project = "oyster" - api = "nudibranch" - api_config = "cuttlefish" - expected = "projects/{project}/locations/global/apis/{api}/configs/{api_config}".format(project=project, api=api, api_config=api_config, ) - actual = ApiGatewayServiceClient.api_config_path(project, api, api_config) - assert expected == actual - - -def test_parse_api_config_path(): - expected = { - "project": "mussel", - "api": "winkle", - "api_config": "nautilus", - } - path = ApiGatewayServiceClient.api_config_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_api_config_path(path) - assert expected == actual - -def test_gateway_path(): - project = "scallop" - location = "abalone" - gateway = "squid" - expected = "projects/{project}/locations/{location}/gateways/{gateway}".format(project=project, location=location, gateway=gateway, ) - actual = ApiGatewayServiceClient.gateway_path(project, location, gateway) - assert expected == actual - - -def test_parse_gateway_path(): - expected = { - "project": "clam", - "location": "whelk", - "gateway": "octopus", - } - path = ApiGatewayServiceClient.gateway_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_gateway_path(path) - assert expected == actual - -def test_managed_service_path(): - service = "oyster" - expected = "services/{service}".format(service=service, ) - actual = ApiGatewayServiceClient.managed_service_path(service) - assert expected == actual - - -def test_parse_managed_service_path(): - expected = { - "service": "nudibranch", - } - path = ApiGatewayServiceClient.managed_service_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_managed_service_path(path) - assert expected == actual - -def test_service_path(): - service = "cuttlefish" - config = "mussel" - expected = "services/{service}/configs/{config}".format(service=service, config=config, ) - actual = ApiGatewayServiceClient.service_path(service, config) - assert expected == actual - - -def test_parse_service_path(): - expected = { - "service": "winkle", - "config": "nautilus", - } - path = ApiGatewayServiceClient.service_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_service_path(path) - assert expected == actual - -def test_service_account_path(): - project = "scallop" - service_account = "abalone" - expected = "projects/{project}/serviceAccounts/{service_account}".format(project=project, service_account=service_account, ) - actual = ApiGatewayServiceClient.service_account_path(project, service_account) - assert expected == actual - - -def test_parse_service_account_path(): - expected = { - "project": "squid", - "service_account": "clam", - } - path = ApiGatewayServiceClient.service_account_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_service_account_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "whelk" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = ApiGatewayServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "octopus", - } - path = ApiGatewayServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "oyster" - expected = "folders/{folder}".format(folder=folder, ) - actual = ApiGatewayServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nudibranch", - } - path = ApiGatewayServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization, ) - actual = ApiGatewayServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "mussel", - } - path = ApiGatewayServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "winkle" - expected = "projects/{project}".format(project=project, ) - actual = ApiGatewayServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "nautilus", - } - path = ApiGatewayServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "scallop" - location = "abalone" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = ApiGatewayServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "squid", - "location": "clam", - } - path = ApiGatewayServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = ApiGatewayServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.ApiGatewayServiceTransport, '_prep_wrapped_messages') as prep: - client = ApiGatewayServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.ApiGatewayServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = ApiGatewayServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py b/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py index 416d800..f46605f 100644 --- a/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py +++ b/tests/unit/gapic/apigateway_v1/test_api_gateway_service.py @@ -129,18 +129,6 @@ def test_api_gateway_service_client_from_service_account_info(client_class): assert client.transport._host == "apigateway.googleapis.com:443" -@pytest.mark.parametrize( - "client_class", [ApiGatewayServiceClient, ApiGatewayServiceAsyncClient,] -) -def test_api_gateway_service_client_service_account_always_use_jwt(client_class): - with mock.patch.object( - service_account.Credentials, "with_always_use_jwt_access", create=True - ) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_not_called() - - @pytest.mark.parametrize( "transport_class,transport_name", [ @@ -148,7 +136,7 @@ def test_api_gateway_service_client_service_account_always_use_jwt(client_class) (transports.ApiGatewayServiceGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_api_gateway_service_client_service_account_always_use_jwt_true( +def test_api_gateway_service_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -158,6 +146,13 @@ def test_api_gateway_service_client_service_account_always_use_jwt_true( transport = transport_class(credentials=creds, always_use_jwt_access=True) use_jwt.assert_called_once_with(True) + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + @pytest.mark.parametrize( "client_class", [ApiGatewayServiceClient, ApiGatewayServiceAsyncClient,] @@ -238,6 +233,7 @@ def test_api_gateway_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -254,6 +250,7 @@ def test_api_gateway_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is @@ -270,6 +267,7 @@ def test_api_gateway_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has @@ -298,6 +296,7 @@ def test_api_gateway_service_client_client_options( client_cert_source_for_mtls=None, quota_project_id="octopus", client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -374,6 +373,7 @@ def test_api_gateway_service_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case ADC client cert is provided. Whether client cert is used depends on @@ -407,6 +407,7 @@ def test_api_gateway_service_client_mtls_env_auto( client_cert_source_for_mtls=expected_client_cert_source, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) # Check the case client_cert_source and ADC client cert are not provided. @@ -428,6 +429,7 @@ def test_api_gateway_service_client_mtls_env_auto( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -458,6 +460,7 @@ def test_api_gateway_service_client_client_options_scopes( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -488,6 +491,7 @@ def test_api_gateway_service_client_client_options_credentials_file( client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, ) @@ -507,6 +511,7 @@ def test_api_gateway_service_client_client_options_from_dict(): client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, )