From 2ad55611301d659186cab7bfc4144343482b1095 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:23:34 +0000 Subject: [PATCH 1/2] docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: https://github.com/googleapis/googleapis/commit/8a085aeddfa010af5bcef090827aac5255383d7e Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 --- owl-bot-staging/v1/.coveragerc | 13 + owl-bot-staging/v1/.flake8 | 33 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 ++ .../essential_contacts_service.rst | 10 + .../docs/essential_contacts_v1/services.rst | 6 + .../v1/docs/essential_contacts_v1/types.rst | 6 + owl-bot-staging/v1/docs/index.rst | 7 + .../cloud/essential_contacts/__init__.py | 51 + .../cloud/essential_contacts/gapic_version.py | 16 + .../google/cloud/essential_contacts/py.typed | 2 + .../cloud/essential_contacts_v1/__init__.py | 52 + .../essential_contacts_v1/gapic_metadata.json | 133 + .../essential_contacts_v1/gapic_version.py | 16 + .../cloud/essential_contacts_v1/py.typed | 2 + .../services/__init__.py | 15 + .../essential_contacts_service/__init__.py | 22 + .../async_client.py | 917 ++++ .../essential_contacts_service/client.py | 1111 ++++ .../essential_contacts_service/pagers.py | 260 + .../transports/__init__.py | 38 + .../transports/base.py | 245 + .../transports/grpc.py | 425 ++ .../transports/grpc_asyncio.py | 424 ++ .../transports/rest.py | 1007 ++++ .../essential_contacts_v1/types/__init__.py | 42 + .../essential_contacts_v1/types/enums.py | 104 + .../essential_contacts_v1/types/service.py | 367 ++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 184 + ...contacts_service_compute_contacts_async.py | 53 + ..._contacts_service_compute_contacts_sync.py | 53 + ...l_contacts_service_create_contact_async.py | 52 + ...al_contacts_service_create_contact_sync.py | 52 + ...l_contacts_service_delete_contact_async.py | 50 + ...al_contacts_service_delete_contact_sync.py | 50 + ...tial_contacts_service_get_contact_async.py | 52 + ...ntial_contacts_service_get_contact_sync.py | 52 + ...al_contacts_service_list_contacts_async.py | 53 + ...ial_contacts_service_list_contacts_sync.py | 53 + ...ontacts_service_send_test_message_async.py | 52 + ...contacts_service_send_test_message_sync.py | 52 + ...l_contacts_service_update_contact_async.py | 51 + ...al_contacts_service_update_contact_sync.py | 51 + ...ata_google.cloud.essentialcontacts.v1.json | 1130 ++++ .../fixup_essential_contacts_v1_keywords.py | 182 + owl-bot-staging/v1/setup.py | 90 + .../v1/testing/constraints-3.10.txt | 6 + .../v1/testing/constraints-3.11.txt | 6 + .../v1/testing/constraints-3.12.txt | 6 + .../v1/testing/constraints-3.7.txt | 9 + .../v1/testing/constraints-3.8.txt | 6 + .../v1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../gapic/essential_contacts_v1/__init__.py | 16 + .../test_essential_contacts_service.py | 4789 +++++++++++++++++ 59 files changed, 12958 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/.flake8 create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst create mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/types.rst create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py create mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/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/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json create mode 100644 owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.9.txt 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/essential_contacts_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..53c04e9 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/essential_contacts/__init__.py + google/cloud/essential_contacts/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..36c6e5b --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/essential_contacts *.py +recursive-include google/cloud/essential_contacts_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..5b4e882 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Essential Contacts 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 Essential Contacts API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..ccd5ed5 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-essential-contacts documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-essential-contacts" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-essential-contacts-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-essential-contacts.tex", + u"google-cloud-essential-contacts Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-essential-contacts", + u"Google Cloud Essential Contacts Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-essential-contacts", + u"google-cloud-essential-contacts Documentation", + author, + "google-cloud-essential-contacts", + "GAPIC library for Google Cloud Essential Contacts 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/essential_contacts_v1/essential_contacts_service.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst new file mode 100644 index 0000000..48399dc --- /dev/null +++ b/owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst @@ -0,0 +1,10 @@ +EssentialContactsService +------------------------------------------ + +.. automodule:: google.cloud.essential_contacts_v1.services.essential_contacts_service + :members: + :inherited-members: + +.. automodule:: google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst new file mode 100644 index 0000000..257d255 --- /dev/null +++ b/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Essential Contacts v1 API +=================================================== +.. toctree:: + :maxdepth: 2 + + essential_contacts_service diff --git a/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst new file mode 100644 index 0000000..75b751d --- /dev/null +++ b/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Essential Contacts v1 API +================================================ + +.. automodule:: google.cloud.essential_contacts_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..7271b21 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + essential_contacts_v1/services + essential_contacts_v1/types diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py new file mode 100644 index 0000000..f94dc7d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.essential_contacts import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.essential_contacts_v1.services.essential_contacts_service.client import EssentialContactsServiceClient +from google.cloud.essential_contacts_v1.services.essential_contacts_service.async_client import EssentialContactsServiceAsyncClient + +from google.cloud.essential_contacts_v1.types.enums import NotificationCategory +from google.cloud.essential_contacts_v1.types.enums import ValidationState +from google.cloud.essential_contacts_v1.types.service import ComputeContactsRequest +from google.cloud.essential_contacts_v1.types.service import ComputeContactsResponse +from google.cloud.essential_contacts_v1.types.service import Contact +from google.cloud.essential_contacts_v1.types.service import CreateContactRequest +from google.cloud.essential_contacts_v1.types.service import DeleteContactRequest +from google.cloud.essential_contacts_v1.types.service import GetContactRequest +from google.cloud.essential_contacts_v1.types.service import ListContactsRequest +from google.cloud.essential_contacts_v1.types.service import ListContactsResponse +from google.cloud.essential_contacts_v1.types.service import SendTestMessageRequest +from google.cloud.essential_contacts_v1.types.service import UpdateContactRequest + +__all__ = ('EssentialContactsServiceClient', + 'EssentialContactsServiceAsyncClient', + 'NotificationCategory', + 'ValidationState', + 'ComputeContactsRequest', + 'ComputeContactsResponse', + 'Contact', + 'CreateContactRequest', + 'DeleteContactRequest', + 'GetContactRequest', + 'ListContactsRequest', + 'ListContactsResponse', + 'SendTestMessageRequest', + 'UpdateContactRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py b/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed b/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed new file mode 100644 index 0000000..90d2cfe --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-essential-contacts package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py new file mode 100644 index 0000000..73a6e4f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.essential_contacts_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.essential_contacts_service import EssentialContactsServiceClient +from .services.essential_contacts_service import EssentialContactsServiceAsyncClient + +from .types.enums import NotificationCategory +from .types.enums import ValidationState +from .types.service import ComputeContactsRequest +from .types.service import ComputeContactsResponse +from .types.service import Contact +from .types.service import CreateContactRequest +from .types.service import DeleteContactRequest +from .types.service import GetContactRequest +from .types.service import ListContactsRequest +from .types.service import ListContactsResponse +from .types.service import SendTestMessageRequest +from .types.service import UpdateContactRequest + +__all__ = ( + 'EssentialContactsServiceAsyncClient', +'ComputeContactsRequest', +'ComputeContactsResponse', +'Contact', +'CreateContactRequest', +'DeleteContactRequest', +'EssentialContactsServiceClient', +'GetContactRequest', +'ListContactsRequest', +'ListContactsResponse', +'NotificationCategory', +'SendTestMessageRequest', +'UpdateContactRequest', +'ValidationState', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json new file mode 100644 index 0000000..e01eb19 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json @@ -0,0 +1,133 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.essential_contacts_v1", + "protoPackage": "google.cloud.essentialcontacts.v1", + "schema": "1.0", + "services": { + "EssentialContactsService": { + "clients": { + "grpc": { + "libraryClient": "EssentialContactsServiceClient", + "rpcs": { + "ComputeContacts": { + "methods": [ + "compute_contacts" + ] + }, + "CreateContact": { + "methods": [ + "create_contact" + ] + }, + "DeleteContact": { + "methods": [ + "delete_contact" + ] + }, + "GetContact": { + "methods": [ + "get_contact" + ] + }, + "ListContacts": { + "methods": [ + "list_contacts" + ] + }, + "SendTestMessage": { + "methods": [ + "send_test_message" + ] + }, + "UpdateContact": { + "methods": [ + "update_contact" + ] + } + } + }, + "grpc-async": { + "libraryClient": "EssentialContactsServiceAsyncClient", + "rpcs": { + "ComputeContacts": { + "methods": [ + "compute_contacts" + ] + }, + "CreateContact": { + "methods": [ + "create_contact" + ] + }, + "DeleteContact": { + "methods": [ + "delete_contact" + ] + }, + "GetContact": { + "methods": [ + "get_contact" + ] + }, + "ListContacts": { + "methods": [ + "list_contacts" + ] + }, + "SendTestMessage": { + "methods": [ + "send_test_message" + ] + }, + "UpdateContact": { + "methods": [ + "update_contact" + ] + } + } + }, + "rest": { + "libraryClient": "EssentialContactsServiceClient", + "rpcs": { + "ComputeContacts": { + "methods": [ + "compute_contacts" + ] + }, + "CreateContact": { + "methods": [ + "create_contact" + ] + }, + "DeleteContact": { + "methods": [ + "delete_contact" + ] + }, + "GetContact": { + "methods": [ + "get_contact" + ] + }, + "ListContacts": { + "methods": [ + "list_contacts" + ] + }, + "SendTestMessage": { + "methods": [ + "send_test_message" + ] + }, + "UpdateContact": { + "methods": [ + "update_contact" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed new file mode 100644 index 0000000..90d2cfe --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-essential-contacts package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py new file mode 100644 index 0000000..1832e58 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import EssentialContactsServiceClient +from .async_client import EssentialContactsServiceAsyncClient + +__all__ = ( + 'EssentialContactsServiceClient', + 'EssentialContactsServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py new file mode 100644 index 0000000..68a0892 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py @@ -0,0 +1,917 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.essential_contacts_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers +from google.cloud.essential_contacts_v1.types import enums +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport +from .client import EssentialContactsServiceClient + + +class EssentialContactsServiceAsyncClient: + """Manages contacts for important Google Cloud notifications.""" + + _client: EssentialContactsServiceClient + + DEFAULT_ENDPOINT = EssentialContactsServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = EssentialContactsServiceClient.DEFAULT_MTLS_ENDPOINT + + contact_path = staticmethod(EssentialContactsServiceClient.contact_path) + parse_contact_path = staticmethod(EssentialContactsServiceClient.parse_contact_path) + common_billing_account_path = staticmethod(EssentialContactsServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(EssentialContactsServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(EssentialContactsServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(EssentialContactsServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(EssentialContactsServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(EssentialContactsServiceClient.parse_common_organization_path) + common_project_path = staticmethod(EssentialContactsServiceClient.common_project_path) + parse_common_project_path = staticmethod(EssentialContactsServiceClient.parse_common_project_path) + common_location_path = staticmethod(EssentialContactsServiceClient.common_location_path) + parse_common_location_path = staticmethod(EssentialContactsServiceClient.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: + EssentialContactsServiceAsyncClient: The constructed client. + """ + return EssentialContactsServiceClient.from_service_account_info.__func__(EssentialContactsServiceAsyncClient, 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: + EssentialContactsServiceAsyncClient: The constructed client. + """ + return EssentialContactsServiceClient.from_service_account_file.__func__(EssentialContactsServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return EssentialContactsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> EssentialContactsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + EssentialContactsServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(EssentialContactsServiceClient).get_transport_class, type(EssentialContactsServiceClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, EssentialContactsServiceTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the essential contacts 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, ~.EssentialContactsServiceTransport]): 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 = EssentialContactsServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_contact(self, + request: Optional[Union[service.CreateContactRequest, dict]] = None, + *, + parent: Optional[str] = None, + contact: Optional[service.Contact] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Adds a new contact for a resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_create_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.CreateContactRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]]): + The request object. Request message for the CreateContact + method. + parent (:class:`str`): + Required. The resource to save this contact for. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact (:class:`google.cloud.essential_contacts_v1.types.Contact`): + Required. The contact to create. Must + specify an email address and language + tag. + + This corresponds to the ``contact`` 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.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, contact]) + 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 = service.CreateContactRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if contact is not None: + request.contact = contact + + # 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_contact, + 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, + ) + + # Done; return the response. + return response + + async def update_contact(self, + request: Optional[Union[service.UpdateContactRequest, dict]] = None, + *, + contact: Optional[service.Contact] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Updates a contact. + Note: A contact's email address cannot be changed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_update_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.UpdateContactRequest( + ) + + # Make the request + response = await client.update_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]]): + The request object. Request message for the UpdateContact + method. + contact (:class:`google.cloud.essential_contacts_v1.types.Contact`): + Required. The contact resource to + replace the existing saved contact. + Note: the email address of the contact + cannot be modified. + + This corresponds to the ``contact`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. The update mask applied to the resource. For + the ``FieldMask`` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + + 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.cloud.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([contact, 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 = service.UpdateContactRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if contact is not None: + request.contact = contact + 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_contact, + 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(( + ("contact.name", request.contact.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_contacts(self, + request: Optional[Union[service.ListContactsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListContactsAsyncPager: + r"""Lists the contacts that have been set on a resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_list_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ListContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_contacts(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.ListContactsRequest, dict]]): + The request object. Request message for the ListContacts + method. + parent (:class:`str`): + Required. The parent resource name. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + + 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.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager: + Response message for the ListContacts + method. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.ListContactsRequest(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_contacts, + default_retry=retries.Retry( +initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListContactsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_contact(self, + request: Optional[Union[service.GetContactRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Gets a single contact. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_get_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.GetContactRequest( + name="name_value", + ) + + # Make the request + response = await client.get_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.GetContactRequest, dict]]): + The request object. Request message for the GetContact + method. + name (:class:`str`): + Required. The name of the contact to retrieve. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + + 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.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.GetContactRequest(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_contact, + default_retry=retries.Retry( +initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_contact(self, + request: Optional[Union[service.DeleteContactRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a contact. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_delete_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.DeleteContactRequest( + name="name_value", + ) + + # Make the request + await client.delete_contact(request=request) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]]): + The request object. Request message for the DeleteContact + method. + name (:class:`str`): + Required. The name of the contact to delete. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + + 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. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = service.DeleteContactRequest(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_contact, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def compute_contacts(self, + request: Optional[Union[service.ComputeContactsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ComputeContactsAsyncPager: + r"""Lists all contacts for the resource that are + subscribed to the specified notification categories, + including contacts inherited from any parent resources. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_compute_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ComputeContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.compute_contacts(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.ComputeContactsRequest, dict]]): + The request object. Request message for the + ComputeContacts method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager: + Response message for the + ComputeContacts method. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + request = service.ComputeContactsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.compute_contacts, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ComputeContactsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def send_test_message(self, + request: Optional[Union[service.SendTestMessageRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Allows a contact admin to send a test message to + contact to verify that it has been configured correctly. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + async def sample_send_test_message(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.SendTestMessageRequest( + contacts=['contacts_value1', 'contacts_value2'], + resource="resource_value", + notification_category="TECHNICAL_INCIDENTS", + ) + + # Make the request + await client.send_test_message(request=request) + + Args: + request (Optional[Union[google.cloud.essential_contacts_v1.types.SendTestMessageRequest, dict]]): + The request object. Request message for the + SendTestMessage method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + request = service.SendTestMessageRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.send_test_message, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "EssentialContactsServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py new file mode 100644 index 0000000..9754712 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py @@ -0,0 +1,1111 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.essential_contacts_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers +from google.cloud.essential_contacts_v1.types import enums +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import EssentialContactsServiceGrpcTransport +from .transports.grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport +from .transports.rest import EssentialContactsServiceRestTransport + + +class EssentialContactsServiceClientMeta(type): + """Metaclass for the EssentialContactsService 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[EssentialContactsServiceTransport]] + _transport_registry["grpc"] = EssentialContactsServiceGrpcTransport + _transport_registry["grpc_asyncio"] = EssentialContactsServiceGrpcAsyncIOTransport + _transport_registry["rest"] = EssentialContactsServiceRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[EssentialContactsServiceTransport]: + """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 EssentialContactsServiceClient(metaclass=EssentialContactsServiceClientMeta): + """Manages contacts for important Google Cloud notifications.""" + + @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 = "essentialcontacts.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: + EssentialContactsServiceClient: 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: + EssentialContactsServiceClient: 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) -> EssentialContactsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + EssentialContactsServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def contact_path(project: str,contact: str,) -> str: + """Returns a fully-qualified contact string.""" + return "projects/{project}/contacts/{contact}".format(project=project, contact=contact, ) + + @staticmethod + def parse_contact_path(path: str) -> Dict[str,str]: + """Parses a contact path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/contacts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, EssentialContactsServiceTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the essential contacts 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, EssentialContactsServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, EssentialContactsServiceTransport): + # transport is a EssentialContactsServiceTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def create_contact(self, + request: Optional[Union[service.CreateContactRequest, dict]] = None, + *, + parent: Optional[str] = None, + contact: Optional[service.Contact] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Adds a new contact for a resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_create_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.CreateContactRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]): + The request object. Request message for the CreateContact + method. + parent (str): + Required. The resource to save this contact for. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + contact (google.cloud.essential_contacts_v1.types.Contact): + Required. The contact to create. Must + specify an email address and language + tag. + + This corresponds to the ``contact`` 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.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, contact]) + 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 service.CreateContactRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.CreateContactRequest): + request = service.CreateContactRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if contact is not None: + request.contact = contact + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_contact] + + # 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, + ) + + # Done; return the response. + return response + + def update_contact(self, + request: Optional[Union[service.UpdateContactRequest, dict]] = None, + *, + contact: Optional[service.Contact] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Updates a contact. + Note: A contact's email address cannot be changed. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_update_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.UpdateContactRequest( + ) + + # Make the request + response = client.update_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]): + The request object. Request message for the UpdateContact + method. + contact (google.cloud.essential_contacts_v1.types.Contact): + Required. The contact resource to + replace the existing saved contact. + Note: the email address of the contact + cannot be modified. + + This corresponds to the ``contact`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The update mask applied to the resource. For + the ``FieldMask`` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + + 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.cloud.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([contact, 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 service.UpdateContactRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.UpdateContactRequest): + request = service.UpdateContactRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if contact is not None: + request.contact = contact + 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_contact] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("contact.name", request.contact.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_contacts(self, + request: Optional[Union[service.ListContactsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListContactsPager: + r"""Lists the contacts that have been set on a resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_list_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ListContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_contacts(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.ListContactsRequest, dict]): + The request object. Request message for the ListContacts + method. + parent (str): + Required. The parent resource name. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + + 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.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager: + Response message for the ListContacts + method. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.ListContactsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.ListContactsRequest): + request = service.ListContactsRequest(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_contacts] + + # 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.ListContactsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_contact(self, + request: Optional[Union[service.GetContactRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> service.Contact: + r"""Gets a single contact. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_get_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.GetContactRequest( + name="name_value", + ) + + # Make the request + response = client.get_contact(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.GetContactRequest, dict]): + The request object. Request message for the GetContact + method. + name (str): + Required. The name of the contact to retrieve. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + + 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.essential_contacts_v1.types.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.GetContactRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.GetContactRequest): + request = service.GetContactRequest(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_contact] + + # 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 delete_contact(self, + request: Optional[Union[service.DeleteContactRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a contact. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_delete_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.DeleteContactRequest( + name="name_value", + ) + + # Make the request + client.delete_contact(request=request) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]): + The request object. Request message for the DeleteContact + method. + name (str): + Required. The name of the contact to delete. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + + 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. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a service.DeleteContactRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.DeleteContactRequest): + request = service.DeleteContactRequest(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_contact] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def compute_contacts(self, + request: Optional[Union[service.ComputeContactsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ComputeContactsPager: + r"""Lists all contacts for the resource that are + subscribed to the specified notification categories, + including contacts inherited from any parent resources. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_compute_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ComputeContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.compute_contacts(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.ComputeContactsRequest, dict]): + The request object. Request message for the + ComputeContacts method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager: + Response message for the + ComputeContacts method. + Iterating over this object will yield + results and resolve additional pages + automatically. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a service.ComputeContactsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.ComputeContactsRequest): + request = service.ComputeContactsRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.compute_contacts] + + # 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.ComputeContactsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def send_test_message(self, + request: Optional[Union[service.SendTestMessageRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Allows a contact admin to send a test message to + contact to verify that it has been configured correctly. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import essential_contacts_v1 + + def sample_send_test_message(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.SendTestMessageRequest( + contacts=['contacts_value1', 'contacts_value2'], + resource="resource_value", + notification_category="TECHNICAL_INCIDENTS", + ) + + # Make the request + client.send_test_message(request=request) + + Args: + request (Union[google.cloud.essential_contacts_v1.types.SendTestMessageRequest, dict]): + The request object. Request message for the + SendTestMessage method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a service.SendTestMessageRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, service.SendTestMessageRequest): + request = service.SendTestMessageRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.send_test_message] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def __enter__(self) -> "EssentialContactsServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "EssentialContactsServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py new file mode 100644 index 0000000..e1f39e9 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.essential_contacts_v1.types import service + + +class ListContactsPager: + """A pager for iterating through ``list_contacts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``contacts`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListContacts`` requests and continue to iterate + through the ``contacts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` + 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[..., service.ListContactsResponse], + request: service.ListContactsRequest, + response: service.ListContactsResponse, + *, + 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.essential_contacts_v1.types.ListContactsRequest): + The initial request object. + response (google.cloud.essential_contacts_v1.types.ListContactsResponse): + 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 = service.ListContactsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[service.ListContactsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[service.Contact]: + for page in self.pages: + yield from page.contacts + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListContactsAsyncPager: + """A pager for iterating through ``list_contacts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``contacts`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListContacts`` requests and continue to iterate + through the ``contacts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` + 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[service.ListContactsResponse]], + request: service.ListContactsRequest, + response: service.ListContactsResponse, + *, + 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.essential_contacts_v1.types.ListContactsRequest): + The initial request object. + response (google.cloud.essential_contacts_v1.types.ListContactsResponse): + 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 = service.ListContactsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[service.ListContactsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[service.Contact]: + async def async_generator(): + async for page in self.pages: + for response in page.contacts: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ComputeContactsPager: + """A pager for iterating through ``compute_contacts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``contacts`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ComputeContacts`` requests and continue to iterate + through the ``contacts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` + 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[..., service.ComputeContactsResponse], + request: service.ComputeContactsRequest, + response: service.ComputeContactsResponse, + *, + 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.essential_contacts_v1.types.ComputeContactsRequest): + The initial request object. + response (google.cloud.essential_contacts_v1.types.ComputeContactsResponse): + 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 = service.ComputeContactsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[service.ComputeContactsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[service.Contact]: + for page in self.pages: + yield from page.contacts + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ComputeContactsAsyncPager: + """A pager for iterating through ``compute_contacts`` requests. + + This class thinly wraps an initial + :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``contacts`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ComputeContacts`` requests and continue to iterate + through the ``contacts`` field on the + corresponding responses. + + All the usual :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` + 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[service.ComputeContactsResponse]], + request: service.ComputeContactsRequest, + response: service.ComputeContactsResponse, + *, + 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.essential_contacts_v1.types.ComputeContactsRequest): + The initial request object. + response (google.cloud.essential_contacts_v1.types.ComputeContactsResponse): + 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 = service.ComputeContactsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[service.ComputeContactsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[service.Contact]: + async def async_generator(): + async for page in self.pages: + for response in page.contacts: + 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/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py new file mode 100644 index 0000000..794d9f6 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import EssentialContactsServiceTransport +from .grpc import EssentialContactsServiceGrpcTransport +from .grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport +from .rest import EssentialContactsServiceRestTransport +from .rest import EssentialContactsServiceRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[EssentialContactsServiceTransport]] +_transport_registry['grpc'] = EssentialContactsServiceGrpcTransport +_transport_registry['grpc_asyncio'] = EssentialContactsServiceGrpcAsyncIOTransport +_transport_registry['rest'] = EssentialContactsServiceRestTransport + +__all__ = ( + 'EssentialContactsServiceTransport', + 'EssentialContactsServiceGrpcTransport', + 'EssentialContactsServiceGrpcAsyncIOTransport', + 'EssentialContactsServiceRestTransport', + 'EssentialContactsServiceRestInterceptor', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py new file mode 100644 index 0000000..f71d4e7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py @@ -0,0 +1,245 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.essential_contacts_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class EssentialContactsServiceTransport(abc.ABC): + """Abstract transport class for EssentialContactsService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'essentialcontacts.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_contact: gapic_v1.method.wrap_method( + self.create_contact, + default_timeout=60.0, + client_info=client_info, + ), + self.update_contact: gapic_v1.method.wrap_method( + self.update_contact, + default_timeout=60.0, + client_info=client_info, + ), + self.list_contacts: gapic_v1.method.wrap_method( + self.list_contacts, + default_retry=retries.Retry( +initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_contact: gapic_v1.method.wrap_method( + self.get_contact, + default_retry=retries.Retry( +initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_contact: gapic_v1.method.wrap_method( + self.delete_contact, + default_timeout=60.0, + client_info=client_info, + ), + self.compute_contacts: gapic_v1.method.wrap_method( + self.compute_contacts, + default_timeout=60.0, + client_info=client_info, + ), + self.send_test_message: gapic_v1.method.wrap_method( + self.send_test_message, + default_timeout=60.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_contact(self) -> Callable[ + [service.CreateContactRequest], + Union[ + service.Contact, + Awaitable[service.Contact] + ]]: + raise NotImplementedError() + + @property + def update_contact(self) -> Callable[ + [service.UpdateContactRequest], + Union[ + service.Contact, + Awaitable[service.Contact] + ]]: + raise NotImplementedError() + + @property + def list_contacts(self) -> Callable[ + [service.ListContactsRequest], + Union[ + service.ListContactsResponse, + Awaitable[service.ListContactsResponse] + ]]: + raise NotImplementedError() + + @property + def get_contact(self) -> Callable[ + [service.GetContactRequest], + Union[ + service.Contact, + Awaitable[service.Contact] + ]]: + raise NotImplementedError() + + @property + def delete_contact(self) -> Callable[ + [service.DeleteContactRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def compute_contacts(self) -> Callable[ + [service.ComputeContactsRequest], + Union[ + service.ComputeContactsResponse, + Awaitable[service.ComputeContactsResponse] + ]]: + raise NotImplementedError() + + @property + def send_test_message(self) -> Callable[ + [service.SendTestMessageRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'EssentialContactsServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py new file mode 100644 index 0000000..77c25c6 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py @@ -0,0 +1,425 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import empty_pb2 # type: ignore +from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO + + +class EssentialContactsServiceGrpcTransport(EssentialContactsServiceTransport): + """gRPC backend transport for EssentialContactsService. + + Manages contacts for important Google Cloud notifications. + + 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 = 'essentialcontacts.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'essentialcontacts.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_contact(self) -> Callable[ + [service.CreateContactRequest], + service.Contact]: + r"""Return a callable for the create contact method over gRPC. + + Adds a new contact for a resource. + + Returns: + Callable[[~.CreateContactRequest], + ~.Contact]: + 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_contact' not in self._stubs: + self._stubs['create_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/CreateContact', + request_serializer=service.CreateContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['create_contact'] + + @property + def update_contact(self) -> Callable[ + [service.UpdateContactRequest], + service.Contact]: + r"""Return a callable for the update contact method over gRPC. + + Updates a contact. + Note: A contact's email address cannot be changed. + + Returns: + Callable[[~.UpdateContactRequest], + ~.Contact]: + 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_contact' not in self._stubs: + self._stubs['update_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/UpdateContact', + request_serializer=service.UpdateContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['update_contact'] + + @property + def list_contacts(self) -> Callable[ + [service.ListContactsRequest], + service.ListContactsResponse]: + r"""Return a callable for the list contacts method over gRPC. + + Lists the contacts that have been set on a resource. + + Returns: + Callable[[~.ListContactsRequest], + ~.ListContactsResponse]: + 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_contacts' not in self._stubs: + self._stubs['list_contacts'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/ListContacts', + request_serializer=service.ListContactsRequest.serialize, + response_deserializer=service.ListContactsResponse.deserialize, + ) + return self._stubs['list_contacts'] + + @property + def get_contact(self) -> Callable[ + [service.GetContactRequest], + service.Contact]: + r"""Return a callable for the get contact method over gRPC. + + Gets a single contact. + + Returns: + Callable[[~.GetContactRequest], + ~.Contact]: + 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_contact' not in self._stubs: + self._stubs['get_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/GetContact', + request_serializer=service.GetContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['get_contact'] + + @property + def delete_contact(self) -> Callable[ + [service.DeleteContactRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete contact method over gRPC. + + Deletes a contact. + + Returns: + Callable[[~.DeleteContactRequest], + ~.Empty]: + 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_contact' not in self._stubs: + self._stubs['delete_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/DeleteContact', + request_serializer=service.DeleteContactRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_contact'] + + @property + def compute_contacts(self) -> Callable[ + [service.ComputeContactsRequest], + service.ComputeContactsResponse]: + r"""Return a callable for the compute contacts method over gRPC. + + Lists all contacts for the resource that are + subscribed to the specified notification categories, + including contacts inherited from any parent resources. + + Returns: + Callable[[~.ComputeContactsRequest], + ~.ComputeContactsResponse]: + 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 'compute_contacts' not in self._stubs: + self._stubs['compute_contacts'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/ComputeContacts', + request_serializer=service.ComputeContactsRequest.serialize, + response_deserializer=service.ComputeContactsResponse.deserialize, + ) + return self._stubs['compute_contacts'] + + @property + def send_test_message(self) -> Callable[ + [service.SendTestMessageRequest], + empty_pb2.Empty]: + r"""Return a callable for the send test message method over gRPC. + + Allows a contact admin to send a test message to + contact to verify that it has been configured correctly. + + Returns: + Callable[[~.SendTestMessageRequest], + ~.Empty]: + 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 'send_test_message' not in self._stubs: + self._stubs['send_test_message'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/SendTestMessage', + request_serializer=service.SendTestMessageRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['send_test_message'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'EssentialContactsServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..276243e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py @@ -0,0 +1,424 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import empty_pb2 # type: ignore +from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import EssentialContactsServiceGrpcTransport + + +class EssentialContactsServiceGrpcAsyncIOTransport(EssentialContactsServiceTransport): + """gRPC AsyncIO backend transport for EssentialContactsService. + + Manages contacts for important Google Cloud notifications. + + 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 = 'essentialcontacts.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'essentialcontacts.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_contact(self) -> Callable[ + [service.CreateContactRequest], + Awaitable[service.Contact]]: + r"""Return a callable for the create contact method over gRPC. + + Adds a new contact for a resource. + + Returns: + Callable[[~.CreateContactRequest], + Awaitable[~.Contact]]: + 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_contact' not in self._stubs: + self._stubs['create_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/CreateContact', + request_serializer=service.CreateContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['create_contact'] + + @property + def update_contact(self) -> Callable[ + [service.UpdateContactRequest], + Awaitable[service.Contact]]: + r"""Return a callable for the update contact method over gRPC. + + Updates a contact. + Note: A contact's email address cannot be changed. + + Returns: + Callable[[~.UpdateContactRequest], + Awaitable[~.Contact]]: + 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_contact' not in self._stubs: + self._stubs['update_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/UpdateContact', + request_serializer=service.UpdateContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['update_contact'] + + @property + def list_contacts(self) -> Callable[ + [service.ListContactsRequest], + Awaitable[service.ListContactsResponse]]: + r"""Return a callable for the list contacts method over gRPC. + + Lists the contacts that have been set on a resource. + + Returns: + Callable[[~.ListContactsRequest], + Awaitable[~.ListContactsResponse]]: + 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_contacts' not in self._stubs: + self._stubs['list_contacts'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/ListContacts', + request_serializer=service.ListContactsRequest.serialize, + response_deserializer=service.ListContactsResponse.deserialize, + ) + return self._stubs['list_contacts'] + + @property + def get_contact(self) -> Callable[ + [service.GetContactRequest], + Awaitable[service.Contact]]: + r"""Return a callable for the get contact method over gRPC. + + Gets a single contact. + + Returns: + Callable[[~.GetContactRequest], + Awaitable[~.Contact]]: + 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_contact' not in self._stubs: + self._stubs['get_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/GetContact', + request_serializer=service.GetContactRequest.serialize, + response_deserializer=service.Contact.deserialize, + ) + return self._stubs['get_contact'] + + @property + def delete_contact(self) -> Callable[ + [service.DeleteContactRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete contact method over gRPC. + + Deletes a contact. + + Returns: + Callable[[~.DeleteContactRequest], + Awaitable[~.Empty]]: + 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_contact' not in self._stubs: + self._stubs['delete_contact'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/DeleteContact', + request_serializer=service.DeleteContactRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_contact'] + + @property + def compute_contacts(self) -> Callable[ + [service.ComputeContactsRequest], + Awaitable[service.ComputeContactsResponse]]: + r"""Return a callable for the compute contacts method over gRPC. + + Lists all contacts for the resource that are + subscribed to the specified notification categories, + including contacts inherited from any parent resources. + + Returns: + Callable[[~.ComputeContactsRequest], + Awaitable[~.ComputeContactsResponse]]: + 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 'compute_contacts' not in self._stubs: + self._stubs['compute_contacts'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/ComputeContacts', + request_serializer=service.ComputeContactsRequest.serialize, + response_deserializer=service.ComputeContactsResponse.deserialize, + ) + return self._stubs['compute_contacts'] + + @property + def send_test_message(self) -> Callable[ + [service.SendTestMessageRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the send test message method over gRPC. + + Allows a contact admin to send a test message to + contact to verify that it has been configured correctly. + + Returns: + Callable[[~.SendTestMessageRequest], + Awaitable[~.Empty]]: + 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 'send_test_message' not in self._stubs: + self._stubs['send_test_message'] = self.grpc_channel.unary_unary( + '/google.cloud.essentialcontacts.v1.EssentialContactsService/SendTestMessage', + request_serializer=service.SendTestMessageRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['send_test_message'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'EssentialContactsServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py new file mode 100644 index 0000000..034f3cf --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py @@ -0,0 +1,1007 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.essential_contacts_v1.types import service +from google.protobuf import empty_pb2 # type: ignore + +from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class EssentialContactsServiceRestInterceptor: + """Interceptor for EssentialContactsService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the EssentialContactsServiceRestTransport. + + .. code-block:: python + class MyCustomEssentialContactsServiceInterceptor(EssentialContactsServiceRestInterceptor): + def pre_compute_contacts(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_compute_contacts(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_contact(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_contact(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_contact(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_contact(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_contact(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_contacts(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_contacts(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_send_test_message(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_update_contact(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_contact(self, response): + logging.log(f"Received response: {response}") + return response + + transport = EssentialContactsServiceRestTransport(interceptor=MyCustomEssentialContactsServiceInterceptor()) + client = EssentialContactsServiceClient(transport=transport) + + + """ + def pre_compute_contacts(self, request: service.ComputeContactsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.ComputeContactsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for compute_contacts + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def post_compute_contacts(self, response: service.ComputeContactsResponse) -> service.ComputeContactsResponse: + """Post-rpc interceptor for compute_contacts + + Override in a subclass to manipulate the response + after it is returned by the EssentialContactsService server but before + it is returned to user code. + """ + return response + def pre_create_contact(self, request: service.CreateContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.CreateContactRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_contact + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def post_create_contact(self, response: service.Contact) -> service.Contact: + """Post-rpc interceptor for create_contact + + Override in a subclass to manipulate the response + after it is returned by the EssentialContactsService server but before + it is returned to user code. + """ + return response + def pre_delete_contact(self, request: service.DeleteContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.DeleteContactRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_contact + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def pre_get_contact(self, request: service.GetContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.GetContactRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_contact + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def post_get_contact(self, response: service.Contact) -> service.Contact: + """Post-rpc interceptor for get_contact + + Override in a subclass to manipulate the response + after it is returned by the EssentialContactsService server but before + it is returned to user code. + """ + return response + def pre_list_contacts(self, request: service.ListContactsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.ListContactsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_contacts + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def post_list_contacts(self, response: service.ListContactsResponse) -> service.ListContactsResponse: + """Post-rpc interceptor for list_contacts + + Override in a subclass to manipulate the response + after it is returned by the EssentialContactsService server but before + it is returned to user code. + """ + return response + def pre_send_test_message(self, request: service.SendTestMessageRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.SendTestMessageRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for send_test_message + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def pre_update_contact(self, request: service.UpdateContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.UpdateContactRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_contact + + Override in a subclass to manipulate the request or metadata + before they are sent to the EssentialContactsService server. + """ + return request, metadata + + def post_update_contact(self, response: service.Contact) -> service.Contact: + """Post-rpc interceptor for update_contact + + Override in a subclass to manipulate the response + after it is returned by the EssentialContactsService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class EssentialContactsServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: EssentialContactsServiceRestInterceptor + + +class EssentialContactsServiceRestTransport(EssentialContactsServiceTransport): + """REST backend transport for EssentialContactsService. + + Manages contacts for important Google Cloud notifications. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'essentialcontacts.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[EssentialContactsServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or EssentialContactsServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ComputeContacts(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("ComputeContacts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.ComputeContactsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> service.ComputeContactsResponse: + r"""Call the compute contacts method over HTTP. + + Args: + request (~.service.ComputeContactsRequest): + The request object. Request message for the + ComputeContacts method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.service.ComputeContactsResponse: + Response message for the + ComputeContacts method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*}/contacts:compute', + }, +{ + 'method': 'get', + 'uri': '/v1/{parent=folders/*}/contacts:compute', + }, +{ + 'method': 'get', + 'uri': '/v1/{parent=organizations/*}/contacts:compute', + }, + ] + request, metadata = self._interceptor.pre_compute_contacts(request, metadata) + pb_request = service.ComputeContactsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = service.ComputeContactsResponse() + pb_resp = service.ComputeContactsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_compute_contacts(resp) + return resp + + class _CreateContact(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("CreateContact") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.CreateContactRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> service.Contact: + r"""Call the create contact method over HTTP. + + Args: + request (~.service.CreateContactRequest): + The request object. Request message for the CreateContact + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.service.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*}/contacts', + 'body': 'contact', + }, +{ + 'method': 'post', + 'uri': '/v1/{parent=folders/*}/contacts', + 'body': 'contact', + }, +{ + 'method': 'post', + 'uri': '/v1/{parent=organizations/*}/contacts', + 'body': 'contact', + }, + ] + request, metadata = self._interceptor.pre_create_contact(request, metadata) + pb_request = service.CreateContactRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = service.Contact() + pb_resp = service.Contact.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_contact(resp) + return resp + + class _DeleteContact(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("DeleteContact") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.DeleteContactRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete contact method over HTTP. + + Args: + request (~.service.DeleteContactRequest): + The request object. Request message for the DeleteContact + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/contacts/*}', + }, +{ + 'method': 'delete', + 'uri': '/v1/{name=folders/*/contacts/*}', + }, +{ + 'method': 'delete', + 'uri': '/v1/{name=organizations/*/contacts/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_contact(request, metadata) + pb_request = service.DeleteContactRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetContact(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("GetContact") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.GetContactRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> service.Contact: + r"""Call the get contact method over HTTP. + + Args: + request (~.service.GetContactRequest): + The request object. Request message for the GetContact + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.service.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/contacts/*}', + }, +{ + 'method': 'get', + 'uri': '/v1/{name=folders/*/contacts/*}', + }, +{ + 'method': 'get', + 'uri': '/v1/{name=organizations/*/contacts/*}', + }, + ] + request, metadata = self._interceptor.pre_get_contact(request, metadata) + pb_request = service.GetContactRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = service.Contact() + pb_resp = service.Contact.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_contact(resp) + return resp + + class _ListContacts(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("ListContacts") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.ListContactsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> service.ListContactsResponse: + r"""Call the list contacts method over HTTP. + + Args: + request (~.service.ListContactsRequest): + The request object. Request message for the ListContacts + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.service.ListContactsResponse: + Response message for the ListContacts + method. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*}/contacts', + }, +{ + 'method': 'get', + 'uri': '/v1/{parent=folders/*}/contacts', + }, +{ + 'method': 'get', + 'uri': '/v1/{parent=organizations/*}/contacts', + }, + ] + request, metadata = self._interceptor.pre_list_contacts(request, metadata) + pb_request = service.ListContactsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = service.ListContactsResponse() + pb_resp = service.ListContactsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_contacts(resp) + return resp + + class _SendTestMessage(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("SendTestMessage") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.SendTestMessageRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the send test message method over HTTP. + + Args: + request (~.service.SendTestMessageRequest): + The request object. Request message for the + SendTestMessage method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{resource=projects/*}/contacts:sendTestMessage', + 'body': '*', + }, +{ + 'method': 'post', + 'uri': '/v1/{resource=folders/*}/contacts:sendTestMessage', + 'body': '*', + }, +{ + 'method': 'post', + 'uri': '/v1/{resource=organizations/*}/contacts:sendTestMessage', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_send_test_message(request, metadata) + pb_request = service.SendTestMessageRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _UpdateContact(EssentialContactsServiceRestStub): + def __hash__(self): + return hash("UpdateContact") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: service.UpdateContactRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> service.Contact: + r"""Call the update contact method over HTTP. + + Args: + request (~.service.UpdateContactRequest): + The request object. Request message for the UpdateContact + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.service.Contact: + A contact that will receive + notifications from Google Cloud. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{contact.name=projects/*/contacts/*}', + 'body': 'contact', + }, +{ + 'method': 'patch', + 'uri': '/v1/{contact.name=folders/*/contacts/*}', + 'body': 'contact', + }, +{ + 'method': 'patch', + 'uri': '/v1/{contact.name=organizations/*/contacts/*}', + 'body': 'contact', + }, + ] + request, metadata = self._interceptor.pre_update_contact(request, metadata) + pb_request = service.UpdateContactRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = service.Contact() + pb_resp = service.Contact.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_contact(resp) + return resp + + @property + def compute_contacts(self) -> Callable[ + [service.ComputeContactsRequest], + service.ComputeContactsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ComputeContacts(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_contact(self) -> Callable[ + [service.CreateContactRequest], + service.Contact]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateContact(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_contact(self) -> Callable[ + [service.DeleteContactRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteContact(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_contact(self) -> Callable[ + [service.GetContactRequest], + service.Contact]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetContact(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_contacts(self) -> Callable[ + [service.ListContactsRequest], + service.ListContactsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListContacts(self._session, self._host, self._interceptor) # type: ignore + + @property + def send_test_message(self) -> Callable[ + [service.SendTestMessageRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SendTestMessage(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_contact(self) -> Callable[ + [service.UpdateContactRequest], + service.Contact]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateContact(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'EssentialContactsServiceRestTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py new file mode 100644 index 0000000..c67f7ab --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py @@ -0,0 +1,42 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .service import ( + ComputeContactsRequest, + ComputeContactsResponse, + Contact, + CreateContactRequest, + DeleteContactRequest, + GetContactRequest, + ListContactsRequest, + ListContactsResponse, + SendTestMessageRequest, + UpdateContactRequest, +) + +__all__ = ( + 'NotificationCategory', + 'ValidationState', + 'ComputeContactsRequest', + 'ComputeContactsResponse', + 'Contact', + 'CreateContactRequest', + 'DeleteContactRequest', + 'GetContactRequest', + 'ListContactsRequest', + 'ListContactsResponse', + 'SendTestMessageRequest', + 'UpdateContactRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py new file mode 100644 index 0000000..aff7b88 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py @@ -0,0 +1,104 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.essentialcontacts.v1', + manifest={ + 'NotificationCategory', + 'ValidationState', + }, +) + + +class NotificationCategory(proto.Enum): + r"""The notification categories that an essential contact can be + subscribed to. Each notification will be categorized by the + sender into one of the following categories. All contacts that + are subscribed to that category will receive the notification. + + Values: + NOTIFICATION_CATEGORY_UNSPECIFIED (0): + Notification category is unrecognized or + unspecified. + ALL (2): + All notifications related to the resource, + including notifications pertaining to categories + added in the future. + SUSPENSION (3): + Notifications related to imminent account + suspension. + SECURITY (5): + Notifications related to security/privacy + incidents, notifications, and vulnerabilities. + TECHNICAL (6): + Notifications related to technical events and + issues such as outages, errors, or bugs. + BILLING (7): + Notifications related to billing and payments + notifications, price updates, errors, or + credits. + LEGAL (8): + Notifications related to enforcement actions, + regulatory compliance, or government notices. + PRODUCT_UPDATES (9): + Notifications related to new versions, + product terms updates, or deprecations. + TECHNICAL_INCIDENTS (10): + Child category of TECHNICAL. If assigned, + technical incident notifications will go to + these contacts instead of TECHNICAL. + """ + NOTIFICATION_CATEGORY_UNSPECIFIED = 0 + ALL = 2 + SUSPENSION = 3 + SECURITY = 5 + TECHNICAL = 6 + BILLING = 7 + LEGAL = 8 + PRODUCT_UPDATES = 9 + TECHNICAL_INCIDENTS = 10 + + +class ValidationState(proto.Enum): + r"""A contact's validation state indicates whether or not it is + the correct contact to be receiving notifications for a + particular resource. + + Values: + VALIDATION_STATE_UNSPECIFIED (0): + The validation state is unknown or + unspecified. + VALID (1): + The contact is marked as valid. This is + usually done manually by the contact admin. All + new contacts begin in the valid state. + INVALID (2): + The contact is considered invalid. This may + become the state if the contact's email is found + to be unreachable. + """ + VALIDATION_STATE_UNSPECIFIED = 0 + VALID = 1 + INVALID = 2 + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py new file mode 100644 index 0000000..3c3e8b2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py @@ -0,0 +1,367 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.cloud.essential_contacts_v1.types import enums +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.essentialcontacts.v1', + manifest={ + 'Contact', + 'ListContactsRequest', + 'ListContactsResponse', + 'GetContactRequest', + 'DeleteContactRequest', + 'CreateContactRequest', + 'UpdateContactRequest', + 'ComputeContactsRequest', + 'ComputeContactsResponse', + 'SendTestMessageRequest', + }, +) + + +class Contact(proto.Message): + r"""A contact that will receive notifications from Google Cloud. + + Attributes: + name (str): + The identifier for the contact. Format: + {resource_type}/{resource_id}/contacts/{contact_id} + email (str): + Required. The email address to send + notifications to. This does not need to be a + Google account. + notification_category_subscriptions (MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]): + The categories of notifications that the + contact will receive communications for. + language_tag (str): + The preferred language for notifications, as a ISO 639-1 + language code. See `Supported + languages `__ + for a list of supported languages. + validation_state (google.cloud.essential_contacts_v1.types.ValidationState): + The validity of the contact. A contact is + considered valid if it is the correct recipient + for notifications for a particular resource. + validate_time (google.protobuf.timestamp_pb2.Timestamp): + The last time the validation_state was updated, either + manually or automatically. A contact is considered stale if + its validation state was updated more than 1 year ago. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + email: str = proto.Field( + proto.STRING, + number=2, + ) + notification_category_subscriptions: MutableSequence[enums.NotificationCategory] = proto.RepeatedField( + proto.ENUM, + number=3, + enum=enums.NotificationCategory, + ) + language_tag: str = proto.Field( + proto.STRING, + number=4, + ) + validation_state: enums.ValidationState = proto.Field( + proto.ENUM, + number=8, + enum=enums.ValidationState, + ) + validate_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + + +class ListContactsRequest(proto.Message): + r"""Request message for the ListContacts method. + + Attributes: + parent (str): + Required. The parent resource name. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + page_size (int): + Optional. The maximum number of results to return from this + request. Non-positive values are ignored. The presence of + ``next_page_token`` in the response indicates that more + results might be available. If not specified, the default + page_size is 100. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters should be + identical to those in the previous call. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListContactsResponse(proto.Message): + r"""Response message for the ListContacts method. + + Attributes: + contacts (MutableSequence[google.cloud.essential_contacts_v1.types.Contact]): + The contacts for the specified resource. + next_page_token (str): + If there are more results than those appearing in this + response, then ``next_page_token`` is included. To get the + next set of results, call this method again using the value + of ``next_page_token`` as ``page_token`` and the rest of the + parameters the same as the original request. + """ + + @property + def raw_page(self): + return self + + contacts: MutableSequence['Contact'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Contact', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetContactRequest(proto.Message): + r"""Request message for the GetContact method. + + Attributes: + name (str): + Required. The name of the contact to retrieve. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteContactRequest(proto.Message): + r"""Request message for the DeleteContact method. + + Attributes: + name (str): + Required. The name of the contact to delete. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateContactRequest(proto.Message): + r"""Request message for the CreateContact method. + + Attributes: + parent (str): + Required. The resource to save this contact for. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + contact (google.cloud.essential_contacts_v1.types.Contact): + Required. The contact to create. Must specify + an email address and language tag. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + contact: 'Contact' = proto.Field( + proto.MESSAGE, + number=2, + message='Contact', + ) + + +class UpdateContactRequest(proto.Message): + r"""Request message for the UpdateContact method. + + Attributes: + contact (google.cloud.essential_contacts_v1.types.Contact): + Required. The contact resource to replace the + existing saved contact. Note: the email address + of the contact cannot be modified. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The update mask applied to the resource. For the + ``FieldMask`` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + """ + + contact: 'Contact' = proto.Field( + proto.MESSAGE, + number=2, + message='Contact', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + + +class ComputeContactsRequest(proto.Message): + r"""Request message for the ComputeContacts method. + + Attributes: + parent (str): + Required. The name of the resource to compute contacts for. + Format: organizations/{organization_id}, folders/{folder_id} + or projects/{project_id} + notification_categories (MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]): + The categories of notifications to compute + contacts for. If ALL is included in this list, + contacts subscribed to any notification category + will be returned. + page_size (int): + Optional. The maximum number of results to return from this + request. Non-positive values are ignored. The presence of + ``next_page_token`` in the response indicates that more + results might be available. If not specified, the default + page_size is 100. + page_token (str): + Optional. If present, retrieves the next batch of results + from the preceding call to this method. ``page_token`` must + be the value of ``next_page_token`` from the previous + response. The values of other method parameters should be + identical to those in the previous call. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + notification_categories: MutableSequence[enums.NotificationCategory] = proto.RepeatedField( + proto.ENUM, + number=6, + enum=enums.NotificationCategory, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ComputeContactsResponse(proto.Message): + r"""Response message for the ComputeContacts method. + + Attributes: + contacts (MutableSequence[google.cloud.essential_contacts_v1.types.Contact]): + All contacts for the resource that are + subscribed to the specified notification + categories, including contacts inherited from + any parent resources. + next_page_token (str): + If there are more results than those appearing in this + response, then ``next_page_token`` is included. To get the + next set of results, call this method again using the value + of ``next_page_token`` as ``page_token`` and the rest of the + parameters the same as the original request. + """ + + @property + def raw_page(self): + return self + + contacts: MutableSequence['Contact'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Contact', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SendTestMessageRequest(proto.Message): + r"""Request message for the SendTestMessage method. + + Attributes: + contacts (MutableSequence[str]): + Required. The list of names of the contacts to send a test + message to. Format: + organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} + resource (str): + Required. The name of the resource to send the test message + for. All contacts must either be set directly on this + resource or inherited from another resource that is an + ancestor of this one. Format: + organizations/{organization_id}, folders/{folder_id} or + projects/{project_id} + notification_category (google.cloud.essential_contacts_v1.types.NotificationCategory): + Required. The notification category to send + the test message for. All contacts must be + subscribed to this category. + """ + + contacts: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + resource: str = proto.Field( + proto.STRING, + number=2, + ) + notification_category: enums.NotificationCategory = proto.Field( + proto.ENUM, + number=3, + enum=enums.NotificationCategory, + ) + + +__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..574c5ae --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..2b843b3 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/essential_contacts_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py new file mode 100644 index 0000000..f4d254e --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ComputeContacts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_compute_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ComputeContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.compute_contacts(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py new file mode 100644 index 0000000..c740d86 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ComputeContacts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_compute_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ComputeContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.compute_contacts(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py new file mode 100644 index 0000000..275adf4 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_create_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.CreateContactRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py new file mode 100644 index 0000000..630c0b8 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_create_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.CreateContactRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py new file mode 100644 index 0000000..80cfb88 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_delete_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.DeleteContactRequest( + name="name_value", + ) + + # Make the request + await client.delete_contact(request=request) + + +# [END essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py new file mode 100644 index 0000000..9d71f81 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_delete_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.DeleteContactRequest( + name="name_value", + ) + + # Make the request + client.delete_contact(request=request) + + +# [END essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py new file mode 100644 index 0000000..05aedb2 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_GetContact_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_get_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.GetContactRequest( + name="name_value", + ) + + # Make the request + response = await client.get_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_GetContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py new file mode 100644 index 0000000..5cc3af2 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_get_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.GetContactRequest( + name="name_value", + ) + + # Make the request + response = client.get_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py new file mode 100644 index 0000000..9230c27 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListContacts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_list_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ListContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_contacts(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py new file mode 100644 index 0000000..0adda6d --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListContacts +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_list_contacts(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.ListContactsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_contacts(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py new file mode 100644 index 0000000..f5779dc --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SendTestMessage +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_send_test_message(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.SendTestMessageRequest( + contacts=['contacts_value1', 'contacts_value2'], + resource="resource_value", + notification_category="TECHNICAL_INCIDENTS", + ) + + # Make the request + await client.send_test_message(request=request) + + +# [END essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py new file mode 100644 index 0000000..73837df --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SendTestMessage +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_send_test_message(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.SendTestMessageRequest( + contacts=['contacts_value1', 'contacts_value2'], + resource="resource_value", + notification_category="TECHNICAL_INCIDENTS", + ) + + # Make the request + client.send_test_message(request=request) + + +# [END essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py new file mode 100644 index 0000000..0255714 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +async def sample_update_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceAsyncClient() + + # Initialize request argument(s) + request = essential_contacts_v1.UpdateContactRequest( + ) + + # Make the request + response = await client.update_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py new file mode 100644 index 0000000..a081f8f --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateContact +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-essential-contacts + + +# [START essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import essential_contacts_v1 + + +def sample_update_contact(): + # Create a client + client = essential_contacts_v1.EssentialContactsServiceClient() + + # Initialize request argument(s) + request = essential_contacts_v1.UpdateContactRequest( + ) + + # Make the request + response = client.update_contact(request=request) + + # Handle the response + print(response) + +# [END essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json new file mode 100644 index 0000000..489bc82 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json @@ -0,0 +1,1130 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.essentialcontacts.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-essential-contacts", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.compute_contacts", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ComputeContacts", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "ComputeContacts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.ComputeContactsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager", + "shortName": "compute_contacts" + }, + "description": "Sample for ComputeContacts", + "file": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.compute_contacts", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ComputeContacts", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "ComputeContacts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.ComputeContactsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager", + "shortName": "compute_contacts" + }, + "description": "Sample for ComputeContacts", + "file": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.create_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.CreateContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "CreateContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.CreateContactRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "contact", + "type": "google.cloud.essential_contacts_v1.types.Contact" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "create_contact" + }, + "description": "Sample for CreateContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.create_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.CreateContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "CreateContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.CreateContactRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "contact", + "type": "google.cloud.essential_contacts_v1.types.Contact" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "create_contact" + }, + "description": "Sample for CreateContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.delete_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.DeleteContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "DeleteContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.DeleteContactRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_contact" + }, + "description": "Sample for DeleteContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.delete_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.DeleteContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "DeleteContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.DeleteContactRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_contact" + }, + "description": "Sample for DeleteContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.get_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.GetContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "GetContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.GetContactRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "get_contact" + }, + "description": "Sample for GetContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_GetContact_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.get_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.GetContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "GetContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.GetContactRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "get_contact" + }, + "description": "Sample for GetContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.list_contacts", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ListContacts", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "ListContacts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.ListContactsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager", + "shortName": "list_contacts" + }, + "description": "Sample for ListContacts", + "file": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.list_contacts", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ListContacts", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "ListContacts" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.ListContactsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager", + "shortName": "list_contacts" + }, + "description": "Sample for ListContacts", + "file": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.send_test_message", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.SendTestMessage", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "SendTestMessage" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.SendTestMessageRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "send_test_message" + }, + "description": "Sample for SendTestMessage", + "file": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.send_test_message", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.SendTestMessage", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "SendTestMessage" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.SendTestMessageRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "send_test_message" + }, + "description": "Sample for SendTestMessage", + "file": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", + "shortName": "EssentialContactsServiceAsyncClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.update_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.UpdateContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "UpdateContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.UpdateContactRequest" + }, + { + "name": "contact", + "type": "google.cloud.essential_contacts_v1.types.Contact" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "update_contact" + }, + "description": "Sample for UpdateContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", + "shortName": "EssentialContactsServiceClient" + }, + "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.update_contact", + "method": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.UpdateContact", + "service": { + "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", + "shortName": "EssentialContactsService" + }, + "shortName": "UpdateContact" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.essential_contacts_v1.types.UpdateContactRequest" + }, + { + "name": "contact", + "type": "google.cloud.essential_contacts_v1.types.Contact" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.essential_contacts_v1.types.Contact", + "shortName": "update_contact" + }, + "description": "Sample for UpdateContact", + "file": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py new file mode 100644 index 0000000..448c7a7 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py @@ -0,0 +1,182 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class essential_contactsCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'compute_contacts': ('parent', 'notification_categories', 'page_size', 'page_token', ), + 'create_contact': ('parent', 'contact', ), + 'delete_contact': ('name', ), + 'get_contact': ('name', ), + 'list_contacts': ('parent', 'page_size', 'page_token', ), + 'send_test_message': ('contacts', 'resource', 'notification_category', ), + 'update_contact': ('contact', '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: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=essential_contactsCallTransformer(), +): + """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 essential_contacts 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..32b9698 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-essential-contacts' + + +description = "Google Cloud Essential Contacts API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/essential_contacts/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-essential-contacts" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py new file mode 100644 index 0000000..0d91123 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py @@ -0,0 +1,4789 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.essential_contacts_v1.services.essential_contacts_service import EssentialContactsServiceAsyncClient +from google.cloud.essential_contacts_v1.services.essential_contacts_service import EssentialContactsServiceClient +from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers +from google.cloud.essential_contacts_v1.services.essential_contacts_service import transports +from google.cloud.essential_contacts_v1.types import enums +from google.cloud.essential_contacts_v1.types import service +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 + + +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 EssentialContactsServiceClient._get_default_mtls_endpoint(None) is None + assert EssentialContactsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert EssentialContactsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert EssentialContactsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert EssentialContactsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert EssentialContactsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (EssentialContactsServiceClient, "grpc"), + (EssentialContactsServiceAsyncClient, "grpc_asyncio"), + (EssentialContactsServiceClient, "rest"), +]) +def test_essential_contacts_service_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'essentialcontacts.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://essentialcontacts.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.EssentialContactsServiceGrpcTransport, "grpc"), + (transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.EssentialContactsServiceRestTransport, "rest"), +]) +def test_essential_contacts_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,transport_name", [ + (EssentialContactsServiceClient, "grpc"), + (EssentialContactsServiceAsyncClient, "grpc_asyncio"), + (EssentialContactsServiceClient, "rest"), +]) +def test_essential_contacts_service_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'essentialcontacts.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://essentialcontacts.googleapis.com' + ) + + +def test_essential_contacts_service_client_get_transport_class(): + transport = EssentialContactsServiceClient.get_transport_class() + available_transports = [ + transports.EssentialContactsServiceGrpcTransport, + transports.EssentialContactsServiceRestTransport, + ] + assert transport in available_transports + + transport = EssentialContactsServiceClient.get_transport_class("grpc") + assert transport == transports.EssentialContactsServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc"), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest"), +]) +@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) +@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) +def test_essential_contacts_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(EssentialContactsServiceClient, '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(EssentialContactsServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", "true"), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", "false"), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", "true"), + (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", "false"), +]) +@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) +@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_essential_contacts_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, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + EssentialContactsServiceClient, EssentialContactsServiceAsyncClient +]) +@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) +@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) +def test_essential_contacts_service_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc"), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest"), +]) +def test_essential_contacts_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, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", grpc_helpers), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", None), +]) +def test_essential_contacts_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_essential_contacts_service_client_client_options_from_dict(): + with mock.patch('google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = EssentialContactsServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", grpc_helpers), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_essential_contacts_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "essentialcontacts.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="essentialcontacts.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + service.CreateContactRequest, + dict, +]) +def test_create_contact(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + response = client.create_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_create_contact_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 = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + client.create_contact() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateContactRequest() + +@pytest.mark.asyncio +async def test_create_contact_async(transport: str = 'grpc_asyncio', request_type=service.CreateContactRequest): + client = EssentialContactsServiceAsyncClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + )) + response = await client.create_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.CreateContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +@pytest.mark.asyncio +async def test_create_contact_async_from_dict(): + await test_create_contact_async(request_type=dict) + + +def test_create_contact_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.CreateContactRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_contact), + '__call__') as call: + call.return_value = service.Contact() + client.create_contact(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_contact_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.CreateContactRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_contact), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + await client.create_contact(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_contact_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_contact( + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].contact + mock_val = service.Contact(name='name_value') + assert arg == mock_val + + +def test_create_contact_flattened_error(): + client = EssentialContactsServiceClient( + 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_contact( + service.CreateContactRequest(), + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_contact_flattened_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_contact( + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].contact + mock_val = service.Contact(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_contact_flattened_error_async(): + client = EssentialContactsServiceAsyncClient( + 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_contact( + service.CreateContactRequest(), + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + service.UpdateContactRequest, + dict, +]) +def test_update_contact(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + response = client.update_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_update_contact_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 = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + client.update_contact() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateContactRequest() + +@pytest.mark.asyncio +async def test_update_contact_async(transport: str = 'grpc_asyncio', request_type=service.UpdateContactRequest): + client = EssentialContactsServiceAsyncClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + )) + response = await client.update_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.UpdateContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +@pytest.mark.asyncio +async def test_update_contact_async_from_dict(): + await test_update_contact_async(request_type=dict) + + +def test_update_contact_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.UpdateContactRequest() + + request.contact.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_contact), + '__call__') as call: + call.return_value = service.Contact() + client.update_contact(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', + 'contact.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_contact_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.UpdateContactRequest() + + request.contact.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_contact), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + await client.update_contact(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', + 'contact.name=name_value', + ) in kw['metadata'] + + +def test_update_contact_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_contact( + contact=service.Contact(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] + arg = args[0].contact + mock_val = service.Contact(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_contact_flattened_error(): + client = EssentialContactsServiceClient( + 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_contact( + service.UpdateContactRequest(), + contact=service.Contact(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_contact_flattened_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_contact( + contact=service.Contact(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] + arg = args[0].contact + mock_val = service.Contact(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_contact_flattened_error_async(): + client = EssentialContactsServiceAsyncClient( + 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_contact( + service.UpdateContactRequest(), + contact=service.Contact(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + service.ListContactsRequest, + dict, +]) +def test_list_contacts(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListContactsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_contacts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListContactsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListContactsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_contacts_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 = EssentialContactsServiceClient( + 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_contacts), + '__call__') as call: + client.list_contacts() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListContactsRequest() + +@pytest.mark.asyncio +async def test_list_contacts_async(transport: str = 'grpc_asyncio', request_type=service.ListContactsRequest): + client = EssentialContactsServiceAsyncClient( + 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_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_contacts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.ListContactsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListContactsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_contacts_async_from_dict(): + await test_list_contacts_async(request_type=dict) + + +def test_list_contacts_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.ListContactsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + call.return_value = service.ListContactsResponse() + client.list_contacts(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_contacts_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.ListContactsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse()) + await client.list_contacts(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_contacts_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListContactsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_contacts( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_contacts_flattened_error(): + client = EssentialContactsServiceClient( + 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_contacts( + service.ListContactsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_contacts_flattened_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ListContactsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_contacts( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_contacts_flattened_error_async(): + client = EssentialContactsServiceAsyncClient( + 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_contacts( + service.ListContactsRequest(), + parent='parent_value', + ) + + +def test_list_contacts_pager(transport_name: str = "grpc"): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ListContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_contacts(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, service.Contact) + for i in results) +def test_list_contacts_pages(transport_name: str = "grpc"): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ListContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + pages = list(client.list_contacts(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_contacts_async_pager(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ListContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_contacts(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, service.Contact) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_contacts_async_pages(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_contacts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ListContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_contacts(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + service.GetContactRequest, + dict, +]) +def test_get_contact(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + response = client.get_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_get_contact_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 = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + client.get_contact() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetContactRequest() + +@pytest.mark.asyncio +async def test_get_contact_async(transport: str = 'grpc_asyncio', request_type=service.GetContactRequest): + client = EssentialContactsServiceAsyncClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + )) + response = await client.get_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.GetContactRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +@pytest.mark.asyncio +async def test_get_contact_async_from_dict(): + await test_get_contact_async(request_type=dict) + + +def test_get_contact_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.GetContactRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_contact), + '__call__') as call: + call.return_value = service.Contact() + client.get_contact(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_contact_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.GetContactRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_contact), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + await client.get_contact(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_contact_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_contact( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_contact_flattened_error(): + client = EssentialContactsServiceClient( + 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_contact( + service.GetContactRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_contact_flattened_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.Contact() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_contact( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_contact_flattened_error_async(): + client = EssentialContactsServiceAsyncClient( + 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_contact( + service.GetContactRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + service.DeleteContactRequest, + dict, +]) +def test_delete_contact(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteContactRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_contact_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 = EssentialContactsServiceClient( + 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_contact), + '__call__') as call: + client.delete_contact() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteContactRequest() + +@pytest.mark.asyncio +async def test_delete_contact_async(transport: str = 'grpc_asyncio', request_type=service.DeleteContactRequest): + client = EssentialContactsServiceAsyncClient( + 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_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_contact(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.DeleteContactRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_contact_async_from_dict(): + await test_delete_contact_async(request_type=dict) + + +def test_delete_contact_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.DeleteContactRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_contact), + '__call__') as call: + call.return_value = None + client.delete_contact(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_contact_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.DeleteContactRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_contact), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_contact(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_contact_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_contact( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_contact_flattened_error(): + client = EssentialContactsServiceClient( + 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_contact( + service.DeleteContactRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_contact_flattened_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_contact), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_contact( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_contact_flattened_error_async(): + client = EssentialContactsServiceAsyncClient( + 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_contact( + service.DeleteContactRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + service.ComputeContactsRequest, + dict, +]) +def test_compute_contacts(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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.compute_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = service.ComputeContactsResponse( + next_page_token='next_page_token_value', + ) + response = client.compute_contacts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.ComputeContactsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ComputeContactsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_compute_contacts_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 = EssentialContactsServiceClient( + 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.compute_contacts), + '__call__') as call: + client.compute_contacts() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.ComputeContactsRequest() + +@pytest.mark.asyncio +async def test_compute_contacts_async(transport: str = 'grpc_asyncio', request_type=service.ComputeContactsRequest): + client = EssentialContactsServiceAsyncClient( + 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.compute_contacts), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ComputeContactsResponse( + next_page_token='next_page_token_value', + )) + response = await client.compute_contacts(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.ComputeContactsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ComputeContactsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_compute_contacts_async_from_dict(): + await test_compute_contacts_async(request_type=dict) + + +def test_compute_contacts_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.ComputeContactsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__') as call: + call.return_value = service.ComputeContactsResponse() + client.compute_contacts(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_compute_contacts_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.ComputeContactsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ComputeContactsResponse()) + await client.compute_contacts(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_compute_contacts_pager(transport_name: str = "grpc"): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ComputeContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.compute_contacts(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, service.Contact) + for i in results) +def test_compute_contacts_pages(transport_name: str = "grpc"): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ComputeContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + pages = list(client.compute_contacts(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_compute_contacts_async_pager(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ComputeContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + async_pager = await client.compute_contacts(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, service.Contact) + for i in responses) + + +@pytest.mark.asyncio +async def test_compute_contacts_async_pages(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.compute_contacts), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ComputeContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.compute_contacts(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + service.SendTestMessageRequest, + dict, +]) +def test_send_test_message(request_type, transport: str = 'grpc'): + client = EssentialContactsServiceClient( + 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.send_test_message), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.send_test_message(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == service.SendTestMessageRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_send_test_message_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 = EssentialContactsServiceClient( + 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.send_test_message), + '__call__') as call: + client.send_test_message() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == service.SendTestMessageRequest() + +@pytest.mark.asyncio +async def test_send_test_message_async(transport: str = 'grpc_asyncio', request_type=service.SendTestMessageRequest): + client = EssentialContactsServiceAsyncClient( + 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.send_test_message), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.send_test_message(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == service.SendTestMessageRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_send_test_message_async_from_dict(): + await test_send_test_message_async(request_type=dict) + + +def test_send_test_message_field_headers(): + client = EssentialContactsServiceClient( + 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 = service.SendTestMessageRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.send_test_message), + '__call__') as call: + call.return_value = None + client.send_test_message(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_send_test_message_field_headers_async(): + client = EssentialContactsServiceAsyncClient( + 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 = service.SendTestMessageRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.send_test_message), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.send_test_message(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + service.CreateContactRequest, + dict, +]) +def test_create_contact_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request_init["contact"] = {'name': 'name_value', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_contact(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_create_contact_rest_required_fields(request_type=service.CreateContactRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = service.Contact() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_contact(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_contact_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_contact._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "contact", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_contact_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_create_contact") as post, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_create_contact") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = service.CreateContactRequest.pb(service.CreateContactRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = service.Contact.to_json(service.Contact()) + + request = service.CreateContactRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = service.Contact() + + client.create_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_contact_rest_bad_request(transport: str = 'rest', request_type=service.CreateContactRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request_init["contact"] = {'name': 'name_value', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_contact(request) + + +def test_create_contact_rest_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_contact(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*}/contacts" % client.transport._host, args[1]) + + +def test_create_contact_rest_flattened_error(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_contact( + service.CreateContactRequest(), + parent='parent_value', + contact=service.Contact(name='name_value'), + ) + + +def test_create_contact_rest_error(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + service.UpdateContactRequest, + dict, +]) +def test_update_contact_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'contact': {'name': 'projects/sample1/contacts/sample2'}} + request_init["contact"] = {'name': 'projects/sample1/contacts/sample2', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_contact(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_update_contact_rest_required_fields(request_type=service.UpdateContactRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_contact._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = service.Contact() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_contact(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_contact_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_contact._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("contact", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_contact_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_update_contact") as post, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_update_contact") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = service.UpdateContactRequest.pb(service.UpdateContactRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = service.Contact.to_json(service.Contact()) + + request = service.UpdateContactRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = service.Contact() + + client.update_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_contact_rest_bad_request(transport: str = 'rest', request_type=service.UpdateContactRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'contact': {'name': 'projects/sample1/contacts/sample2'}} + request_init["contact"] = {'name': 'projects/sample1/contacts/sample2', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_contact(request) + + +def test_update_contact_rest_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact() + + # get arguments that satisfy an http rule for this method + sample_request = {'contact': {'name': 'projects/sample1/contacts/sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + contact=service.Contact(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_contact(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{contact.name=projects/*/contacts/*}" % client.transport._host, args[1]) + + +def test_update_contact_rest_flattened_error(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_contact( + service.UpdateContactRequest(), + contact=service.Contact(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_contact_rest_error(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + service.ListContactsRequest, + dict, +]) +def test_list_contacts_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.ListContactsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.ListContactsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_contacts(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListContactsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_contacts_rest_required_fields(request_type=service.ListContactsRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_contacts._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_contacts._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = service.ListContactsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = service.ListContactsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_contacts(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_contacts_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_contacts._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_contacts_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_list_contacts") as post, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_list_contacts") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = service.ListContactsRequest.pb(service.ListContactsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = service.ListContactsResponse.to_json(service.ListContactsResponse()) + + request = service.ListContactsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = service.ListContactsResponse() + + client.list_contacts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_contacts_rest_bad_request(transport: str = 'rest', request_type=service.ListContactsRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_contacts(request) + + +def test_list_contacts_rest_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.ListContactsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.ListContactsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_contacts(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{parent=projects/*}/contacts" % client.transport._host, args[1]) + + +def test_list_contacts_rest_flattened_error(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_contacts( + service.ListContactsRequest(), + parent='parent_value', + ) + + +def test_list_contacts_rest_pager(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ListContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ListContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(service.ListContactsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1'} + + pager = client.list_contacts(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, service.Contact) + for i in results) + + pages = list(client.list_contacts(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + service.GetContactRequest, + dict, +]) +def test_get_contact_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/contacts/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact( + name='name_value', + email='email_value', + notification_category_subscriptions=[enums.NotificationCategory.ALL], + language_tag='language_tag_value', + validation_state=enums.ValidationState.VALID, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_contact(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, service.Contact) + assert response.name == 'name_value' + assert response.email == 'email_value' + assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] + assert response.language_tag == 'language_tag_value' + assert response.validation_state == enums.ValidationState.VALID + + +def test_get_contact_rest_required_fields(request_type=service.GetContactRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = service.Contact() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_contact(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_contact_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_contact._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_contact_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_get_contact") as post, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_get_contact") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = service.GetContactRequest.pb(service.GetContactRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = service.Contact.to_json(service.Contact()) + + request = service.GetContactRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = service.Contact() + + client.get_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_contact_rest_bad_request(transport: str = 'rest', request_type=service.GetContactRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/contacts/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_contact(request) + + +def test_get_contact_rest_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.Contact() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/contacts/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.Contact.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_contact(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/contacts/*}" % client.transport._host, args[1]) + + +def test_get_contact_rest_flattened_error(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_contact( + service.GetContactRequest(), + name='name_value', + ) + + +def test_get_contact_rest_error(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + service.DeleteContactRequest, + dict, +]) +def test_delete_contact_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/contacts/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_contact(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_contact_rest_required_fields(request_type=service.DeleteContactRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_contact._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_contact(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_contact_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_contact._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_contact_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_delete_contact") as pre: + pre.assert_not_called() + pb_message = service.DeleteContactRequest.pb(service.DeleteContactRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = service.DeleteContactRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_contact_rest_bad_request(transport: str = 'rest', request_type=service.DeleteContactRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/contacts/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_contact(request) + + +def test_delete_contact_rest_flattened(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/contacts/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_contact(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v1/{name=projects/*/contacts/*}" % client.transport._host, args[1]) + + +def test_delete_contact_rest_flattened_error(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_contact( + service.DeleteContactRequest(), + name='name_value', + ) + + +def test_delete_contact_rest_error(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + service.ComputeContactsRequest, + dict, +]) +def test_compute_contacts_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = service.ComputeContactsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = service.ComputeContactsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.compute_contacts(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ComputeContactsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_compute_contacts_rest_required_fields(request_type=service.ComputeContactsRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).compute_contacts._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).compute_contacts._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("notification_categories", "page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = service.ComputeContactsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = service.ComputeContactsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.compute_contacts(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_compute_contacts_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.compute_contacts._get_unset_required_fields({}) + assert set(unset_fields) == (set(("notificationCategories", "pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_compute_contacts_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_compute_contacts") as post, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_compute_contacts") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = service.ComputeContactsRequest.pb(service.ComputeContactsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = service.ComputeContactsResponse.to_json(service.ComputeContactsResponse()) + + request = service.ComputeContactsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = service.ComputeContactsResponse() + + client.compute_contacts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_compute_contacts_rest_bad_request(transport: str = 'rest', request_type=service.ComputeContactsRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.compute_contacts(request) + + +def test_compute_contacts_rest_pager(transport: str = 'rest'): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + service.Contact(), + ], + next_page_token='abc', + ), + service.ComputeContactsResponse( + contacts=[], + next_page_token='def', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + ], + next_page_token='ghi', + ), + service.ComputeContactsResponse( + contacts=[ + service.Contact(), + service.Contact(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(service.ComputeContactsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1'} + + pager = client.compute_contacts(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, service.Contact) + for i in results) + + pages = list(client.compute_contacts(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + service.SendTestMessageRequest, + dict, +]) +def test_send_test_message_rest(request_type): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.send_test_message(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_send_test_message_rest_required_fields(request_type=service.SendTestMessageRequest): + transport_class = transports.EssentialContactsServiceRestTransport + + request_init = {} + request_init["contacts"] = "" + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).send_test_message._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["contacts"] = 'contacts_value' + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).send_test_message._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "contacts" in jsonified_request + assert jsonified_request["contacts"] == 'contacts_value' + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.send_test_message(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_send_test_message_rest_unset_required_fields(): + transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.send_test_message._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("contacts", "resource", "notificationCategory", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_send_test_message_rest_interceptors(null_interceptor): + transport = transports.EssentialContactsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), + ) + client = EssentialContactsServiceClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_send_test_message") as pre: + pre.assert_not_called() + pb_message = service.SendTestMessageRequest.pb(service.SendTestMessageRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = service.SendTestMessageRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.send_test_message(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_send_test_message_rest_bad_request(transport: str = 'rest', request_type=service.SendTestMessageRequest): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.send_test_message(request) + + +def test_send_test_message_rest_error(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = EssentialContactsServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = EssentialContactsServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = EssentialContactsServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = EssentialContactsServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = EssentialContactsServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.EssentialContactsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.EssentialContactsServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.EssentialContactsServiceGrpcTransport, + transports.EssentialContactsServiceGrpcAsyncIOTransport, + transports.EssentialContactsServiceRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = EssentialContactsServiceClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.EssentialContactsServiceGrpcTransport, + ) + +def test_essential_contacts_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.EssentialContactsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_essential_contacts_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.EssentialContactsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_contact', + 'update_contact', + 'list_contacts', + 'get_contact', + 'delete_contact', + 'compute_contacts', + 'send_test_message', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_essential_contacts_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.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.EssentialContactsServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_essential_contacts_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.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.EssentialContactsServiceTransport() + adc.assert_called_once() + + +def test_essential_contacts_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) + EssentialContactsServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.EssentialContactsServiceGrpcTransport, + transports.EssentialContactsServiceGrpcAsyncIOTransport, + ], +) +def test_essential_contacts_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.EssentialContactsServiceGrpcTransport, + transports.EssentialContactsServiceGrpcAsyncIOTransport, + transports.EssentialContactsServiceRestTransport, + ], +) +def test_essential_contacts_service_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.EssentialContactsServiceGrpcTransport, grpc_helpers), + (transports.EssentialContactsServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_essential_contacts_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( + "essentialcontacts.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="essentialcontacts.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) +def test_essential_contacts_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_essential_contacts_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.EssentialContactsServiceRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_essential_contacts_service_host_no_port(transport_name): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='essentialcontacts.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'essentialcontacts.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://essentialcontacts.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_essential_contacts_service_host_with_port(transport_name): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='essentialcontacts.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'essentialcontacts.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://essentialcontacts.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_essential_contacts_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = EssentialContactsServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = EssentialContactsServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_contact._session + session2 = client2.transport.create_contact._session + assert session1 != session2 + session1 = client1.transport.update_contact._session + session2 = client2.transport.update_contact._session + assert session1 != session2 + session1 = client1.transport.list_contacts._session + session2 = client2.transport.list_contacts._session + assert session1 != session2 + session1 = client1.transport.get_contact._session + session2 = client2.transport.get_contact._session + assert session1 != session2 + session1 = client1.transport.delete_contact._session + session2 = client2.transport.delete_contact._session + assert session1 != session2 + session1 = client1.transport.compute_contacts._session + session2 = client2.transport.compute_contacts._session + assert session1 != session2 + session1 = client1.transport.send_test_message._session + session2 = client2.transport.send_test_message._session + assert session1 != session2 +def test_essential_contacts_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.EssentialContactsServiceGrpcTransport( + 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_essential_contacts_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.EssentialContactsServiceGrpcAsyncIOTransport( + 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.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) +def test_essential_contacts_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.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) +def test_essential_contacts_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_contact_path(): + project = "squid" + contact = "clam" + expected = "projects/{project}/contacts/{contact}".format(project=project, contact=contact, ) + actual = EssentialContactsServiceClient.contact_path(project, contact) + assert expected == actual + + +def test_parse_contact_path(): + expected = { + "project": "whelk", + "contact": "octopus", + } + path = EssentialContactsServiceClient.contact_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_contact_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = EssentialContactsServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = EssentialContactsServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format(folder=folder, ) + actual = EssentialContactsServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = EssentialContactsServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format(organization=organization, ) + actual = EssentialContactsServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = EssentialContactsServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format(project=project, ) + actual = EssentialContactsServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = EssentialContactsServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = EssentialContactsServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = EssentialContactsServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = EssentialContactsServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.EssentialContactsServiceTransport, '_prep_wrapped_messages') as prep: + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.EssentialContactsServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = EssentialContactsServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = EssentialContactsServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = EssentialContactsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport), + (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) From f145aaaaef8d469e309ccff09deddbf4a2598acf Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:25:02 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../async_client.py | 12 +- .../essential_contacts_service/client.py | 12 +- .../transports/rest.py | 7 - owl-bot-staging/v1/.coveragerc | 13 - owl-bot-staging/v1/.flake8 | 33 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 -- .../essential_contacts_service.rst | 10 - .../docs/essential_contacts_v1/services.rst | 6 - .../v1/docs/essential_contacts_v1/types.rst | 6 - owl-bot-staging/v1/docs/index.rst | 7 - .../cloud/essential_contacts/__init__.py | 51 - .../cloud/essential_contacts/gapic_version.py | 16 - .../google/cloud/essential_contacts/py.typed | 2 - .../cloud/essential_contacts_v1/__init__.py | 52 - .../essential_contacts_v1/gapic_metadata.json | 133 - .../essential_contacts_v1/gapic_version.py | 16 - .../cloud/essential_contacts_v1/py.typed | 2 - .../services/__init__.py | 15 - .../essential_contacts_service/__init__.py | 22 - .../async_client.py | 917 ---- .../essential_contacts_service/client.py | 1111 ---- .../essential_contacts_service/pagers.py | 260 - .../transports/__init__.py | 38 - .../transports/base.py | 245 - .../transports/grpc.py | 425 -- .../transports/grpc_asyncio.py | 424 -- .../transports/rest.py | 1007 ---- .../essential_contacts_v1/types/__init__.py | 42 - .../essential_contacts_v1/types/enums.py | 104 - .../essential_contacts_v1/types/service.py | 367 -- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 184 - ...contacts_service_compute_contacts_async.py | 53 - ..._contacts_service_compute_contacts_sync.py | 53 - ...l_contacts_service_create_contact_async.py | 52 - ...al_contacts_service_create_contact_sync.py | 52 - ...l_contacts_service_delete_contact_async.py | 50 - ...al_contacts_service_delete_contact_sync.py | 50 - ...tial_contacts_service_get_contact_async.py | 52 - ...ntial_contacts_service_get_contact_sync.py | 52 - ...al_contacts_service_list_contacts_async.py | 53 - ...ial_contacts_service_list_contacts_sync.py | 53 - ...ontacts_service_send_test_message_async.py | 52 - ...contacts_service_send_test_message_sync.py | 52 - ...l_contacts_service_update_contact_async.py | 51 - ...al_contacts_service_update_contact_sync.py | 51 - ...ata_google.cloud.essentialcontacts.v1.json | 1130 ---- .../fixup_essential_contacts_v1_keywords.py | 182 - owl-bot-staging/v1/setup.py | 90 - .../v1/testing/constraints-3.10.txt | 6 - .../v1/testing/constraints-3.11.txt | 6 - .../v1/testing/constraints-3.12.txt | 6 - .../v1/testing/constraints-3.7.txt | 9 - .../v1/testing/constraints-3.8.txt | 6 - .../v1/testing/constraints-3.9.txt | 6 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../gapic/essential_contacts_v1/__init__.py | 16 - .../test_essential_contacts_service.py | 4789 ----------------- 62 files changed, 12 insertions(+), 12977 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/.flake8 delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst delete mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/essential_contacts_v1/types.rst delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py delete mode 100644 owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/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/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json delete mode 100644 owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v1/testing/constraints-3.9.txt 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/essential_contacts_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py diff --git a/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py b/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py index ea96c24..5c25432 100644 --- a/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py +++ b/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py @@ -264,8 +264,8 @@ async def sample_create_contact(): Args: request (Optional[Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]]): - The request object. Request message for the - CreateContact method. + The request object. Request message for the CreateContact + method. parent (:class:`str`): Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or @@ -378,8 +378,8 @@ async def sample_update_contact(): Args: request (Optional[Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]]): - The request object. Request message for the - UpdateContact method. + The request object. Request message for the UpdateContact + method. contact (:class:`google.cloud.essential_contacts_v1.types.Contact`): Required. The contact resource to replace the existing saved contact. @@ -729,8 +729,8 @@ async def sample_delete_contact(): Args: request (Optional[Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]]): - The request object. Request message for the - DeleteContact method. + The request object. Request message for the DeleteContact + method. name (:class:`str`): Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, diff --git a/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py b/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py index dbc4d89..2b197bd 100644 --- a/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py +++ b/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py @@ -483,8 +483,8 @@ def sample_create_contact(): Args: request (Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]): - The request object. Request message for the - CreateContact method. + The request object. Request message for the CreateContact + method. parent (str): Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or @@ -597,8 +597,8 @@ def sample_update_contact(): Args: request (Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]): - The request object. Request message for the - UpdateContact method. + The request object. Request message for the UpdateContact + method. contact (google.cloud.essential_contacts_v1.types.Contact): Required. The contact resource to replace the existing saved contact. @@ -930,8 +930,8 @@ def sample_delete_contact(): Args: request (Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]): - The request object. Request message for the - DeleteContact method. + The request object. Request message for the DeleteContact + method. name (str): Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, diff --git a/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py b/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py index d5e94ad..304f0b8 100644 --- a/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py +++ b/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py @@ -367,7 +367,6 @@ def __call__( request (~.service.ComputeContactsRequest): The request object. Request message for the ComputeContacts method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -467,7 +466,6 @@ def __call__( request (~.service.CreateContactRequest): The request object. Request message for the CreateContact method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -576,7 +574,6 @@ def __call__( request (~.service.DeleteContactRequest): The request object. Request message for the DeleteContact method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -660,7 +657,6 @@ def __call__( request (~.service.GetContactRequest): The request object. Request message for the GetContact method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -758,7 +754,6 @@ def __call__( request (~.service.ListContactsRequest): The request object. Request message for the ListContacts method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -856,7 +851,6 @@ def __call__( request (~.service.SendTestMessageRequest): The request object. Request message for the SendTestMessage method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -953,7 +947,6 @@ def __call__( request (~.service.UpdateContactRequest): The request object. Request message for the UpdateContact method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index 53c04e9..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/essential_contacts/__init__.py - google/cloud/essential_contacts/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v1/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 36c6e5b..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/essential_contacts *.py -recursive-include google/cloud/essential_contacts_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 5b4e882..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Essential Contacts 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 Essential Contacts API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index ccd5ed5..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-cloud-essential-contacts documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-cloud-essential-contacts" -copyright = u"2022, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-essential-contacts-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - root_doc, - "google-cloud-essential-contacts.tex", - u"google-cloud-essential-contacts Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - root_doc, - "google-cloud-essential-contacts", - u"Google Cloud Essential Contacts Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - root_doc, - "google-cloud-essential-contacts", - u"google-cloud-essential-contacts Documentation", - author, - "google-cloud-essential-contacts", - "GAPIC library for Google Cloud Essential Contacts 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/essential_contacts_v1/essential_contacts_service.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst deleted file mode 100644 index 48399dc..0000000 --- a/owl-bot-staging/v1/docs/essential_contacts_v1/essential_contacts_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -EssentialContactsService ------------------------------------------- - -.. automodule:: google.cloud.essential_contacts_v1.services.essential_contacts_service - :members: - :inherited-members: - -.. automodule:: google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst deleted file mode 100644 index 257d255..0000000 --- a/owl-bot-staging/v1/docs/essential_contacts_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Essential Contacts v1 API -=================================================== -.. toctree:: - :maxdepth: 2 - - essential_contacts_service diff --git a/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst b/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst deleted file mode 100644 index 75b751d..0000000 --- a/owl-bot-staging/v1/docs/essential_contacts_v1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Essential Contacts v1 API -================================================ - -.. automodule:: google.cloud.essential_contacts_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index 7271b21..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - essential_contacts_v1/services - essential_contacts_v1/types diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py deleted file mode 100644 index f94dc7d..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts/__init__.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.essential_contacts import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.essential_contacts_v1.services.essential_contacts_service.client import EssentialContactsServiceClient -from google.cloud.essential_contacts_v1.services.essential_contacts_service.async_client import EssentialContactsServiceAsyncClient - -from google.cloud.essential_contacts_v1.types.enums import NotificationCategory -from google.cloud.essential_contacts_v1.types.enums import ValidationState -from google.cloud.essential_contacts_v1.types.service import ComputeContactsRequest -from google.cloud.essential_contacts_v1.types.service import ComputeContactsResponse -from google.cloud.essential_contacts_v1.types.service import Contact -from google.cloud.essential_contacts_v1.types.service import CreateContactRequest -from google.cloud.essential_contacts_v1.types.service import DeleteContactRequest -from google.cloud.essential_contacts_v1.types.service import GetContactRequest -from google.cloud.essential_contacts_v1.types.service import ListContactsRequest -from google.cloud.essential_contacts_v1.types.service import ListContactsResponse -from google.cloud.essential_contacts_v1.types.service import SendTestMessageRequest -from google.cloud.essential_contacts_v1.types.service import UpdateContactRequest - -__all__ = ('EssentialContactsServiceClient', - 'EssentialContactsServiceAsyncClient', - 'NotificationCategory', - 'ValidationState', - 'ComputeContactsRequest', - 'ComputeContactsResponse', - 'Contact', - 'CreateContactRequest', - 'DeleteContactRequest', - 'GetContactRequest', - 'ListContactsRequest', - 'ListContactsResponse', - 'SendTestMessageRequest', - 'UpdateContactRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py b/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed b/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed deleted file mode 100644 index 90d2cfe..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-essential-contacts package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py deleted file mode 100644 index 73a6e4f..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/__init__.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.essential_contacts_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.essential_contacts_service import EssentialContactsServiceClient -from .services.essential_contacts_service import EssentialContactsServiceAsyncClient - -from .types.enums import NotificationCategory -from .types.enums import ValidationState -from .types.service import ComputeContactsRequest -from .types.service import ComputeContactsResponse -from .types.service import Contact -from .types.service import CreateContactRequest -from .types.service import DeleteContactRequest -from .types.service import GetContactRequest -from .types.service import ListContactsRequest -from .types.service import ListContactsResponse -from .types.service import SendTestMessageRequest -from .types.service import UpdateContactRequest - -__all__ = ( - 'EssentialContactsServiceAsyncClient', -'ComputeContactsRequest', -'ComputeContactsResponse', -'Contact', -'CreateContactRequest', -'DeleteContactRequest', -'EssentialContactsServiceClient', -'GetContactRequest', -'ListContactsRequest', -'ListContactsResponse', -'NotificationCategory', -'SendTestMessageRequest', -'UpdateContactRequest', -'ValidationState', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json deleted file mode 100644 index e01eb19..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_metadata.json +++ /dev/null @@ -1,133 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.essential_contacts_v1", - "protoPackage": "google.cloud.essentialcontacts.v1", - "schema": "1.0", - "services": { - "EssentialContactsService": { - "clients": { - "grpc": { - "libraryClient": "EssentialContactsServiceClient", - "rpcs": { - "ComputeContacts": { - "methods": [ - "compute_contacts" - ] - }, - "CreateContact": { - "methods": [ - "create_contact" - ] - }, - "DeleteContact": { - "methods": [ - "delete_contact" - ] - }, - "GetContact": { - "methods": [ - "get_contact" - ] - }, - "ListContacts": { - "methods": [ - "list_contacts" - ] - }, - "SendTestMessage": { - "methods": [ - "send_test_message" - ] - }, - "UpdateContact": { - "methods": [ - "update_contact" - ] - } - } - }, - "grpc-async": { - "libraryClient": "EssentialContactsServiceAsyncClient", - "rpcs": { - "ComputeContacts": { - "methods": [ - "compute_contacts" - ] - }, - "CreateContact": { - "methods": [ - "create_contact" - ] - }, - "DeleteContact": { - "methods": [ - "delete_contact" - ] - }, - "GetContact": { - "methods": [ - "get_contact" - ] - }, - "ListContacts": { - "methods": [ - "list_contacts" - ] - }, - "SendTestMessage": { - "methods": [ - "send_test_message" - ] - }, - "UpdateContact": { - "methods": [ - "update_contact" - ] - } - } - }, - "rest": { - "libraryClient": "EssentialContactsServiceClient", - "rpcs": { - "ComputeContacts": { - "methods": [ - "compute_contacts" - ] - }, - "CreateContact": { - "methods": [ - "create_contact" - ] - }, - "DeleteContact": { - "methods": [ - "delete_contact" - ] - }, - "GetContact": { - "methods": [ - "get_contact" - ] - }, - "ListContacts": { - "methods": [ - "list_contacts" - ] - }, - "SendTestMessage": { - "methods": [ - "send_test_message" - ] - }, - "UpdateContact": { - "methods": [ - "update_contact" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed deleted file mode 100644 index 90d2cfe..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-essential-contacts package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py deleted file mode 100644 index e8e1c38..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py deleted file mode 100644 index 1832e58..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import EssentialContactsServiceClient -from .async_client import EssentialContactsServiceAsyncClient - -__all__ = ( - 'EssentialContactsServiceClient', - 'EssentialContactsServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py deleted file mode 100644 index 68a0892..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/async_client.py +++ /dev/null @@ -1,917 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.essential_contacts_v1 import gapic_version as package_version - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers -from google.cloud.essential_contacts_v1.types import enums -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport -from .client import EssentialContactsServiceClient - - -class EssentialContactsServiceAsyncClient: - """Manages contacts for important Google Cloud notifications.""" - - _client: EssentialContactsServiceClient - - DEFAULT_ENDPOINT = EssentialContactsServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = EssentialContactsServiceClient.DEFAULT_MTLS_ENDPOINT - - contact_path = staticmethod(EssentialContactsServiceClient.contact_path) - parse_contact_path = staticmethod(EssentialContactsServiceClient.parse_contact_path) - common_billing_account_path = staticmethod(EssentialContactsServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(EssentialContactsServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(EssentialContactsServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(EssentialContactsServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(EssentialContactsServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(EssentialContactsServiceClient.parse_common_organization_path) - common_project_path = staticmethod(EssentialContactsServiceClient.common_project_path) - parse_common_project_path = staticmethod(EssentialContactsServiceClient.parse_common_project_path) - common_location_path = staticmethod(EssentialContactsServiceClient.common_location_path) - parse_common_location_path = staticmethod(EssentialContactsServiceClient.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: - EssentialContactsServiceAsyncClient: The constructed client. - """ - return EssentialContactsServiceClient.from_service_account_info.__func__(EssentialContactsServiceAsyncClient, 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: - EssentialContactsServiceAsyncClient: The constructed client. - """ - return EssentialContactsServiceClient.from_service_account_file.__func__(EssentialContactsServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - return EssentialContactsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> EssentialContactsServiceTransport: - """Returns the transport used by the client instance. - - Returns: - EssentialContactsServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(EssentialContactsServiceClient).get_transport_class, type(EssentialContactsServiceClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, EssentialContactsServiceTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the essential contacts 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, ~.EssentialContactsServiceTransport]): 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 = EssentialContactsServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_contact(self, - request: Optional[Union[service.CreateContactRequest, dict]] = None, - *, - parent: Optional[str] = None, - contact: Optional[service.Contact] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Adds a new contact for a resource. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_create_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.CreateContactRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]]): - The request object. Request message for the CreateContact - method. - parent (:class:`str`): - Required. The resource to save this contact for. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact (:class:`google.cloud.essential_contacts_v1.types.Contact`): - Required. The contact to create. Must - specify an email address and language - tag. - - This corresponds to the ``contact`` 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.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, contact]) - 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 = service.CreateContactRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if contact is not None: - request.contact = contact - - # 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_contact, - 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, - ) - - # Done; return the response. - return response - - async def update_contact(self, - request: Optional[Union[service.UpdateContactRequest, dict]] = None, - *, - contact: Optional[service.Contact] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Updates a contact. - Note: A contact's email address cannot be changed. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_update_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.UpdateContactRequest( - ) - - # Make the request - response = await client.update_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]]): - The request object. Request message for the UpdateContact - method. - contact (:class:`google.cloud.essential_contacts_v1.types.Contact`): - Required. The contact resource to - replace the existing saved contact. - Note: the email address of the contact - cannot be modified. - - This corresponds to the ``contact`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Optional. The update mask applied to the resource. For - the ``FieldMask`` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - - 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.cloud.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([contact, 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 = service.UpdateContactRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if contact is not None: - request.contact = contact - 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_contact, - 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(( - ("contact.name", request.contact.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_contacts(self, - request: Optional[Union[service.ListContactsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListContactsAsyncPager: - r"""Lists the contacts that have been set on a resource. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_list_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ListContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_contacts(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.ListContactsRequest, dict]]): - The request object. Request message for the ListContacts - method. - parent (:class:`str`): - Required. The parent resource name. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - - 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.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager: - Response message for the ListContacts - method. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.ListContactsRequest(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_contacts, - default_retry=retries.Retry( -initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListContactsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_contact(self, - request: Optional[Union[service.GetContactRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Gets a single contact. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_get_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.GetContactRequest( - name="name_value", - ) - - # Make the request - response = await client.get_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.GetContactRequest, dict]]): - The request object. Request message for the GetContact - method. - name (:class:`str`): - Required. The name of the contact to retrieve. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - - 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.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.GetContactRequest(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_contact, - default_retry=retries.Retry( -initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_contact(self, - request: Optional[Union[service.DeleteContactRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a contact. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_delete_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.DeleteContactRequest( - name="name_value", - ) - - # Make the request - await client.delete_contact(request=request) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]]): - The request object. Request message for the DeleteContact - method. - name (:class:`str`): - Required. The name of the contact to delete. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - - 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. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = service.DeleteContactRequest(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_contact, - 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. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def compute_contacts(self, - request: Optional[Union[service.ComputeContactsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ComputeContactsAsyncPager: - r"""Lists all contacts for the resource that are - subscribed to the specified notification categories, - including contacts inherited from any parent resources. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_compute_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ComputeContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.compute_contacts(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.ComputeContactsRequest, dict]]): - The request object. Request message for the - ComputeContacts method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager: - Response message for the - ComputeContacts method. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - request = service.ComputeContactsRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.compute_contacts, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ComputeContactsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def send_test_message(self, - request: Optional[Union[service.SendTestMessageRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Allows a contact admin to send a test message to - contact to verify that it has been configured correctly. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - async def sample_send_test_message(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.SendTestMessageRequest( - contacts=['contacts_value1', 'contacts_value2'], - resource="resource_value", - notification_category="TECHNICAL_INCIDENTS", - ) - - # Make the request - await client.send_test_message(request=request) - - Args: - request (Optional[Union[google.cloud.essential_contacts_v1.types.SendTestMessageRequest, dict]]): - The request object. Request message for the - SendTestMessage method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - request = service.SendTestMessageRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.send_test_message, - default_timeout=60.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "EssentialContactsServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py deleted file mode 100644 index 9754712..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/client.py +++ /dev/null @@ -1,1111 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.essential_contacts_v1 import gapic_version as package_version - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers -from google.cloud.essential_contacts_v1.types import enums -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import EssentialContactsServiceGrpcTransport -from .transports.grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport -from .transports.rest import EssentialContactsServiceRestTransport - - -class EssentialContactsServiceClientMeta(type): - """Metaclass for the EssentialContactsService 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[EssentialContactsServiceTransport]] - _transport_registry["grpc"] = EssentialContactsServiceGrpcTransport - _transport_registry["grpc_asyncio"] = EssentialContactsServiceGrpcAsyncIOTransport - _transport_registry["rest"] = EssentialContactsServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[EssentialContactsServiceTransport]: - """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 EssentialContactsServiceClient(metaclass=EssentialContactsServiceClientMeta): - """Manages contacts for important Google Cloud notifications.""" - - @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 = "essentialcontacts.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: - EssentialContactsServiceClient: 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: - EssentialContactsServiceClient: 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) -> EssentialContactsServiceTransport: - """Returns the transport used by the client instance. - - Returns: - EssentialContactsServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def contact_path(project: str,contact: str,) -> str: - """Returns a fully-qualified contact string.""" - return "projects/{project}/contacts/{contact}".format(project=project, contact=contact, ) - - @staticmethod - def parse_contact_path(path: str) -> Dict[str,str]: - """Parses a contact path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/contacts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, EssentialContactsServiceTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the essential contacts 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, EssentialContactsServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - client_options = cast(client_options_lib.ClientOptions, client_options) - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, EssentialContactsServiceTransport): - # transport is a EssentialContactsServiceTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def create_contact(self, - request: Optional[Union[service.CreateContactRequest, dict]] = None, - *, - parent: Optional[str] = None, - contact: Optional[service.Contact] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Adds a new contact for a resource. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_create_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.CreateContactRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]): - The request object. Request message for the CreateContact - method. - parent (str): - Required. The resource to save this contact for. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contact (google.cloud.essential_contacts_v1.types.Contact): - Required. The contact to create. Must - specify an email address and language - tag. - - This corresponds to the ``contact`` 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.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent, contact]) - 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 service.CreateContactRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.CreateContactRequest): - request = service.CreateContactRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if contact is not None: - request.contact = contact - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_contact] - - # 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, - ) - - # Done; return the response. - return response - - def update_contact(self, - request: Optional[Union[service.UpdateContactRequest, dict]] = None, - *, - contact: Optional[service.Contact] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Updates a contact. - Note: A contact's email address cannot be changed. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_update_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.UpdateContactRequest( - ) - - # Make the request - response = client.update_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]): - The request object. Request message for the UpdateContact - method. - contact (google.cloud.essential_contacts_v1.types.Contact): - Required. The contact resource to - replace the existing saved contact. - Note: the email address of the contact - cannot be modified. - - This corresponds to the ``contact`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. The update mask applied to the resource. For - the ``FieldMask`` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - - 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.cloud.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([contact, 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 service.UpdateContactRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.UpdateContactRequest): - request = service.UpdateContactRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if contact is not None: - request.contact = contact - 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_contact] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("contact.name", request.contact.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_contacts(self, - request: Optional[Union[service.ListContactsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListContactsPager: - r"""Lists the contacts that have been set on a resource. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_list_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ListContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_contacts(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.ListContactsRequest, dict]): - The request object. Request message for the ListContacts - method. - parent (str): - Required. The parent resource name. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - - 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.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager: - Response message for the ListContacts - method. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([parent]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.ListContactsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.ListContactsRequest): - request = service.ListContactsRequest(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_contacts] - - # 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.ListContactsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_contact(self, - request: Optional[Union[service.GetContactRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> service.Contact: - r"""Gets a single contact. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_get_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.GetContactRequest( - name="name_value", - ) - - # Make the request - response = client.get_contact(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.GetContactRequest, dict]): - The request object. Request message for the GetContact - method. - name (str): - Required. The name of the contact to retrieve. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - - 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.essential_contacts_v1.types.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.GetContactRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.GetContactRequest): - request = service.GetContactRequest(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_contact] - - # 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 delete_contact(self, - request: Optional[Union[service.DeleteContactRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a contact. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_delete_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.DeleteContactRequest( - name="name_value", - ) - - # Make the request - client.delete_contact(request=request) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]): - The request object. Request message for the DeleteContact - method. - name (str): - Required. The name of the contact to delete. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - - 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. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([name]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a service.DeleteContactRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.DeleteContactRequest): - request = service.DeleteContactRequest(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_contact] - - # 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. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def compute_contacts(self, - request: Optional[Union[service.ComputeContactsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ComputeContactsPager: - r"""Lists all contacts for the resource that are - subscribed to the specified notification categories, - including contacts inherited from any parent resources. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_compute_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ComputeContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.compute_contacts(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.ComputeContactsRequest, dict]): - The request object. Request message for the - ComputeContacts method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager: - Response message for the - ComputeContacts method. - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a service.ComputeContactsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.ComputeContactsRequest): - request = service.ComputeContactsRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.compute_contacts] - - # 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.ComputeContactsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def send_test_message(self, - request: Optional[Union[service.SendTestMessageRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Allows a contact admin to send a test message to - contact to verify that it has been configured correctly. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import essential_contacts_v1 - - def sample_send_test_message(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.SendTestMessageRequest( - contacts=['contacts_value1', 'contacts_value2'], - resource="resource_value", - notification_category="TECHNICAL_INCIDENTS", - ) - - # Make the request - client.send_test_message(request=request) - - Args: - request (Union[google.cloud.essential_contacts_v1.types.SendTestMessageRequest, dict]): - The request object. Request message for the - SendTestMessage method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a service.SendTestMessageRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, service.SendTestMessageRequest): - request = service.SendTestMessageRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.send_test_message] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def __enter__(self) -> "EssentialContactsServiceClient": - return self - - def __exit__(self, type, value, traceback): - """Releases underlying transport's resources. - - .. warning:: - ONLY use as a context manager if the transport is NOT shared - with other clients! Exiting the with block will CLOSE the transport - and may cause errors in other clients! - """ - self.transport.close() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "EssentialContactsServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py deleted file mode 100644 index e1f39e9..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/pagers.py +++ /dev/null @@ -1,260 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.essential_contacts_v1.types import service - - -class ListContactsPager: - """A pager for iterating through ``list_contacts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``contacts`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListContacts`` requests and continue to iterate - through the ``contacts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` - 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[..., service.ListContactsResponse], - request: service.ListContactsRequest, - response: service.ListContactsResponse, - *, - 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.essential_contacts_v1.types.ListContactsRequest): - The initial request object. - response (google.cloud.essential_contacts_v1.types.ListContactsResponse): - 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 = service.ListContactsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[service.ListContactsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[service.Contact]: - for page in self.pages: - yield from page.contacts - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListContactsAsyncPager: - """A pager for iterating through ``list_contacts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``contacts`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListContacts`` requests and continue to iterate - through the ``contacts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.essential_contacts_v1.types.ListContactsResponse` - 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[service.ListContactsResponse]], - request: service.ListContactsRequest, - response: service.ListContactsResponse, - *, - 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.essential_contacts_v1.types.ListContactsRequest): - The initial request object. - response (google.cloud.essential_contacts_v1.types.ListContactsResponse): - 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 = service.ListContactsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[service.ListContactsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[service.Contact]: - async def async_generator(): - async for page in self.pages: - for response in page.contacts: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ComputeContactsPager: - """A pager for iterating through ``compute_contacts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``contacts`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ComputeContacts`` requests and continue to iterate - through the ``contacts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` - 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[..., service.ComputeContactsResponse], - request: service.ComputeContactsRequest, - response: service.ComputeContactsResponse, - *, - 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.essential_contacts_v1.types.ComputeContactsRequest): - The initial request object. - response (google.cloud.essential_contacts_v1.types.ComputeContactsResponse): - 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 = service.ComputeContactsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[service.ComputeContactsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[service.Contact]: - for page in self.pages: - yield from page.contacts - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ComputeContactsAsyncPager: - """A pager for iterating through ``compute_contacts`` requests. - - This class thinly wraps an initial - :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``contacts`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ComputeContacts`` requests and continue to iterate - through the ``contacts`` field on the - corresponding responses. - - All the usual :class:`google.cloud.essential_contacts_v1.types.ComputeContactsResponse` - 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[service.ComputeContactsResponse]], - request: service.ComputeContactsRequest, - response: service.ComputeContactsResponse, - *, - 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.essential_contacts_v1.types.ComputeContactsRequest): - The initial request object. - response (google.cloud.essential_contacts_v1.types.ComputeContactsResponse): - 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 = service.ComputeContactsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[service.ComputeContactsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[service.Contact]: - async def async_generator(): - async for page in self.pages: - for response in page.contacts: - 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/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py deleted file mode 100644 index 794d9f6..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import EssentialContactsServiceTransport -from .grpc import EssentialContactsServiceGrpcTransport -from .grpc_asyncio import EssentialContactsServiceGrpcAsyncIOTransport -from .rest import EssentialContactsServiceRestTransport -from .rest import EssentialContactsServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[EssentialContactsServiceTransport]] -_transport_registry['grpc'] = EssentialContactsServiceGrpcTransport -_transport_registry['grpc_asyncio'] = EssentialContactsServiceGrpcAsyncIOTransport -_transport_registry['rest'] = EssentialContactsServiceRestTransport - -__all__ = ( - 'EssentialContactsServiceTransport', - 'EssentialContactsServiceGrpcTransport', - 'EssentialContactsServiceGrpcAsyncIOTransport', - 'EssentialContactsServiceRestTransport', - 'EssentialContactsServiceRestInterceptor', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py deleted file mode 100644 index f71d4e7..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/base.py +++ /dev/null @@ -1,245 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union - -from google.cloud.essential_contacts_v1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import empty_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class EssentialContactsServiceTransport(abc.ABC): - """Abstract transport class for EssentialContactsService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'essentialcontacts.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_contact: gapic_v1.method.wrap_method( - self.create_contact, - default_timeout=60.0, - client_info=client_info, - ), - self.update_contact: gapic_v1.method.wrap_method( - self.update_contact, - default_timeout=60.0, - client_info=client_info, - ), - self.list_contacts: gapic_v1.method.wrap_method( - self.list_contacts, - default_retry=retries.Retry( -initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.get_contact: gapic_v1.method.wrap_method( - self.get_contact, - default_retry=retries.Retry( -initial=1.0,maximum=10.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.ServiceUnavailable, - ), - deadline=60.0, - ), - default_timeout=60.0, - client_info=client_info, - ), - self.delete_contact: gapic_v1.method.wrap_method( - self.delete_contact, - default_timeout=60.0, - client_info=client_info, - ), - self.compute_contacts: gapic_v1.method.wrap_method( - self.compute_contacts, - default_timeout=60.0, - client_info=client_info, - ), - self.send_test_message: gapic_v1.method.wrap_method( - self.send_test_message, - default_timeout=60.0, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def create_contact(self) -> Callable[ - [service.CreateContactRequest], - Union[ - service.Contact, - Awaitable[service.Contact] - ]]: - raise NotImplementedError() - - @property - def update_contact(self) -> Callable[ - [service.UpdateContactRequest], - Union[ - service.Contact, - Awaitable[service.Contact] - ]]: - raise NotImplementedError() - - @property - def list_contacts(self) -> Callable[ - [service.ListContactsRequest], - Union[ - service.ListContactsResponse, - Awaitable[service.ListContactsResponse] - ]]: - raise NotImplementedError() - - @property - def get_contact(self) -> Callable[ - [service.GetContactRequest], - Union[ - service.Contact, - Awaitable[service.Contact] - ]]: - raise NotImplementedError() - - @property - def delete_contact(self) -> Callable[ - [service.DeleteContactRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def compute_contacts(self) -> Callable[ - [service.ComputeContactsRequest], - Union[ - service.ComputeContactsResponse, - Awaitable[service.ComputeContactsResponse] - ]]: - raise NotImplementedError() - - @property - def send_test_message(self) -> Callable[ - [service.SendTestMessageRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'EssentialContactsServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py deleted file mode 100644 index 77c25c6..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc.py +++ /dev/null @@ -1,425 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import empty_pb2 # type: ignore -from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO - - -class EssentialContactsServiceGrpcTransport(EssentialContactsServiceTransport): - """gRPC backend transport for EssentialContactsService. - - Manages contacts for important Google Cloud notifications. - - 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 = 'essentialcontacts.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'essentialcontacts.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def create_contact(self) -> Callable[ - [service.CreateContactRequest], - service.Contact]: - r"""Return a callable for the create contact method over gRPC. - - Adds a new contact for a resource. - - Returns: - Callable[[~.CreateContactRequest], - ~.Contact]: - 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_contact' not in self._stubs: - self._stubs['create_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/CreateContact', - request_serializer=service.CreateContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['create_contact'] - - @property - def update_contact(self) -> Callable[ - [service.UpdateContactRequest], - service.Contact]: - r"""Return a callable for the update contact method over gRPC. - - Updates a contact. - Note: A contact's email address cannot be changed. - - Returns: - Callable[[~.UpdateContactRequest], - ~.Contact]: - 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_contact' not in self._stubs: - self._stubs['update_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/UpdateContact', - request_serializer=service.UpdateContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['update_contact'] - - @property - def list_contacts(self) -> Callable[ - [service.ListContactsRequest], - service.ListContactsResponse]: - r"""Return a callable for the list contacts method over gRPC. - - Lists the contacts that have been set on a resource. - - Returns: - Callable[[~.ListContactsRequest], - ~.ListContactsResponse]: - 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_contacts' not in self._stubs: - self._stubs['list_contacts'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/ListContacts', - request_serializer=service.ListContactsRequest.serialize, - response_deserializer=service.ListContactsResponse.deserialize, - ) - return self._stubs['list_contacts'] - - @property - def get_contact(self) -> Callable[ - [service.GetContactRequest], - service.Contact]: - r"""Return a callable for the get contact method over gRPC. - - Gets a single contact. - - Returns: - Callable[[~.GetContactRequest], - ~.Contact]: - 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_contact' not in self._stubs: - self._stubs['get_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/GetContact', - request_serializer=service.GetContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['get_contact'] - - @property - def delete_contact(self) -> Callable[ - [service.DeleteContactRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete contact method over gRPC. - - Deletes a contact. - - Returns: - Callable[[~.DeleteContactRequest], - ~.Empty]: - 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_contact' not in self._stubs: - self._stubs['delete_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/DeleteContact', - request_serializer=service.DeleteContactRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_contact'] - - @property - def compute_contacts(self) -> Callable[ - [service.ComputeContactsRequest], - service.ComputeContactsResponse]: - r"""Return a callable for the compute contacts method over gRPC. - - Lists all contacts for the resource that are - subscribed to the specified notification categories, - including contacts inherited from any parent resources. - - Returns: - Callable[[~.ComputeContactsRequest], - ~.ComputeContactsResponse]: - 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 'compute_contacts' not in self._stubs: - self._stubs['compute_contacts'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/ComputeContacts', - request_serializer=service.ComputeContactsRequest.serialize, - response_deserializer=service.ComputeContactsResponse.deserialize, - ) - return self._stubs['compute_contacts'] - - @property - def send_test_message(self) -> Callable[ - [service.SendTestMessageRequest], - empty_pb2.Empty]: - r"""Return a callable for the send test message method over gRPC. - - Allows a contact admin to send a test message to - contact to verify that it has been configured correctly. - - Returns: - Callable[[~.SendTestMessageRequest], - ~.Empty]: - 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 'send_test_message' not in self._stubs: - self._stubs['send_test_message'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/SendTestMessage', - request_serializer=service.SendTestMessageRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['send_test_message'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'EssentialContactsServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py deleted file mode 100644 index 276243e..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,424 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import empty_pb2 # type: ignore -from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import EssentialContactsServiceGrpcTransport - - -class EssentialContactsServiceGrpcAsyncIOTransport(EssentialContactsServiceTransport): - """gRPC AsyncIO backend transport for EssentialContactsService. - - Manages contacts for important Google Cloud notifications. - - 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 = 'essentialcontacts.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'essentialcontacts.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def create_contact(self) -> Callable[ - [service.CreateContactRequest], - Awaitable[service.Contact]]: - r"""Return a callable for the create contact method over gRPC. - - Adds a new contact for a resource. - - Returns: - Callable[[~.CreateContactRequest], - Awaitable[~.Contact]]: - 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_contact' not in self._stubs: - self._stubs['create_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/CreateContact', - request_serializer=service.CreateContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['create_contact'] - - @property - def update_contact(self) -> Callable[ - [service.UpdateContactRequest], - Awaitable[service.Contact]]: - r"""Return a callable for the update contact method over gRPC. - - Updates a contact. - Note: A contact's email address cannot be changed. - - Returns: - Callable[[~.UpdateContactRequest], - Awaitable[~.Contact]]: - 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_contact' not in self._stubs: - self._stubs['update_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/UpdateContact', - request_serializer=service.UpdateContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['update_contact'] - - @property - def list_contacts(self) -> Callable[ - [service.ListContactsRequest], - Awaitable[service.ListContactsResponse]]: - r"""Return a callable for the list contacts method over gRPC. - - Lists the contacts that have been set on a resource. - - Returns: - Callable[[~.ListContactsRequest], - Awaitable[~.ListContactsResponse]]: - 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_contacts' not in self._stubs: - self._stubs['list_contacts'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/ListContacts', - request_serializer=service.ListContactsRequest.serialize, - response_deserializer=service.ListContactsResponse.deserialize, - ) - return self._stubs['list_contacts'] - - @property - def get_contact(self) -> Callable[ - [service.GetContactRequest], - Awaitable[service.Contact]]: - r"""Return a callable for the get contact method over gRPC. - - Gets a single contact. - - Returns: - Callable[[~.GetContactRequest], - Awaitable[~.Contact]]: - 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_contact' not in self._stubs: - self._stubs['get_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/GetContact', - request_serializer=service.GetContactRequest.serialize, - response_deserializer=service.Contact.deserialize, - ) - return self._stubs['get_contact'] - - @property - def delete_contact(self) -> Callable[ - [service.DeleteContactRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete contact method over gRPC. - - Deletes a contact. - - Returns: - Callable[[~.DeleteContactRequest], - Awaitable[~.Empty]]: - 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_contact' not in self._stubs: - self._stubs['delete_contact'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/DeleteContact', - request_serializer=service.DeleteContactRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_contact'] - - @property - def compute_contacts(self) -> Callable[ - [service.ComputeContactsRequest], - Awaitable[service.ComputeContactsResponse]]: - r"""Return a callable for the compute contacts method over gRPC. - - Lists all contacts for the resource that are - subscribed to the specified notification categories, - including contacts inherited from any parent resources. - - Returns: - Callable[[~.ComputeContactsRequest], - Awaitable[~.ComputeContactsResponse]]: - 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 'compute_contacts' not in self._stubs: - self._stubs['compute_contacts'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/ComputeContacts', - request_serializer=service.ComputeContactsRequest.serialize, - response_deserializer=service.ComputeContactsResponse.deserialize, - ) - return self._stubs['compute_contacts'] - - @property - def send_test_message(self) -> Callable[ - [service.SendTestMessageRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the send test message method over gRPC. - - Allows a contact admin to send a test message to - contact to verify that it has been configured correctly. - - Returns: - Callable[[~.SendTestMessageRequest], - Awaitable[~.Empty]]: - 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 'send_test_message' not in self._stubs: - self._stubs['send_test_message'] = self.grpc_channel.unary_unary( - '/google.cloud.essentialcontacts.v1.EssentialContactsService/SendTestMessage', - request_serializer=service.SendTestMessageRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['send_test_message'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'EssentialContactsServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py deleted file mode 100644 index 034f3cf..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/services/essential_contacts_service/transports/rest.py +++ /dev/null @@ -1,1007 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - - -from google.cloud.essential_contacts_v1.types import service -from google.protobuf import empty_pb2 # type: ignore - -from .base import EssentialContactsServiceTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class EssentialContactsServiceRestInterceptor: - """Interceptor for EssentialContactsService. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the EssentialContactsServiceRestTransport. - - .. code-block:: python - class MyCustomEssentialContactsServiceInterceptor(EssentialContactsServiceRestInterceptor): - def pre_compute_contacts(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_compute_contacts(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_contact(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_contact(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_contact(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_contact(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_contact(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_contacts(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_contacts(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_send_test_message(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_update_contact(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_contact(self, response): - logging.log(f"Received response: {response}") - return response - - transport = EssentialContactsServiceRestTransport(interceptor=MyCustomEssentialContactsServiceInterceptor()) - client = EssentialContactsServiceClient(transport=transport) - - - """ - def pre_compute_contacts(self, request: service.ComputeContactsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.ComputeContactsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for compute_contacts - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def post_compute_contacts(self, response: service.ComputeContactsResponse) -> service.ComputeContactsResponse: - """Post-rpc interceptor for compute_contacts - - Override in a subclass to manipulate the response - after it is returned by the EssentialContactsService server but before - it is returned to user code. - """ - return response - def pre_create_contact(self, request: service.CreateContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.CreateContactRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for create_contact - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def post_create_contact(self, response: service.Contact) -> service.Contact: - """Post-rpc interceptor for create_contact - - Override in a subclass to manipulate the response - after it is returned by the EssentialContactsService server but before - it is returned to user code. - """ - return response - def pre_delete_contact(self, request: service.DeleteContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.DeleteContactRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_contact - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def pre_get_contact(self, request: service.GetContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.GetContactRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_contact - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def post_get_contact(self, response: service.Contact) -> service.Contact: - """Post-rpc interceptor for get_contact - - Override in a subclass to manipulate the response - after it is returned by the EssentialContactsService server but before - it is returned to user code. - """ - return response - def pre_list_contacts(self, request: service.ListContactsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.ListContactsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_contacts - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def post_list_contacts(self, response: service.ListContactsResponse) -> service.ListContactsResponse: - """Post-rpc interceptor for list_contacts - - Override in a subclass to manipulate the response - after it is returned by the EssentialContactsService server but before - it is returned to user code. - """ - return response - def pre_send_test_message(self, request: service.SendTestMessageRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.SendTestMessageRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for send_test_message - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def pre_update_contact(self, request: service.UpdateContactRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[service.UpdateContactRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_contact - - Override in a subclass to manipulate the request or metadata - before they are sent to the EssentialContactsService server. - """ - return request, metadata - - def post_update_contact(self, response: service.Contact) -> service.Contact: - """Post-rpc interceptor for update_contact - - Override in a subclass to manipulate the response - after it is returned by the EssentialContactsService server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class EssentialContactsServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: EssentialContactsServiceRestInterceptor - - -class EssentialContactsServiceRestTransport(EssentialContactsServiceTransport): - """REST backend transport for EssentialContactsService. - - Manages contacts for important Google Cloud notifications. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'essentialcontacts.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[Callable[[ - ], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - interceptor: Optional[EssentialContactsServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or EssentialContactsServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ComputeContacts(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("ComputeContacts") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.ComputeContactsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> service.ComputeContactsResponse: - r"""Call the compute contacts method over HTTP. - - Args: - request (~.service.ComputeContactsRequest): - The request object. Request message for the - ComputeContacts method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.service.ComputeContactsResponse: - Response message for the - ComputeContacts method. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*}/contacts:compute', - }, -{ - 'method': 'get', - 'uri': '/v1/{parent=folders/*}/contacts:compute', - }, -{ - 'method': 'get', - 'uri': '/v1/{parent=organizations/*}/contacts:compute', - }, - ] - request, metadata = self._interceptor.pre_compute_contacts(request, metadata) - pb_request = service.ComputeContactsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = service.ComputeContactsResponse() - pb_resp = service.ComputeContactsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_compute_contacts(resp) - return resp - - class _CreateContact(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("CreateContact") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.CreateContactRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> service.Contact: - r"""Call the create contact method over HTTP. - - Args: - request (~.service.CreateContactRequest): - The request object. Request message for the CreateContact - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.service.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*}/contacts', - 'body': 'contact', - }, -{ - 'method': 'post', - 'uri': '/v1/{parent=folders/*}/contacts', - 'body': 'contact', - }, -{ - 'method': 'post', - 'uri': '/v1/{parent=organizations/*}/contacts', - 'body': 'contact', - }, - ] - request, metadata = self._interceptor.pre_create_contact(request, metadata) - pb_request = service.CreateContactRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = service.Contact() - pb_resp = service.Contact.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_create_contact(resp) - return resp - - class _DeleteContact(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("DeleteContact") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.DeleteContactRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete contact method over HTTP. - - Args: - request (~.service.DeleteContactRequest): - The request object. Request message for the DeleteContact - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/contacts/*}', - }, -{ - 'method': 'delete', - 'uri': '/v1/{name=folders/*/contacts/*}', - }, -{ - 'method': 'delete', - 'uri': '/v1/{name=organizations/*/contacts/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_contact(request, metadata) - pb_request = service.DeleteContactRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _GetContact(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("GetContact") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.GetContactRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> service.Contact: - r"""Call the get contact method over HTTP. - - Args: - request (~.service.GetContactRequest): - The request object. Request message for the GetContact - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.service.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/contacts/*}', - }, -{ - 'method': 'get', - 'uri': '/v1/{name=folders/*/contacts/*}', - }, -{ - 'method': 'get', - 'uri': '/v1/{name=organizations/*/contacts/*}', - }, - ] - request, metadata = self._interceptor.pre_get_contact(request, metadata) - pb_request = service.GetContactRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = service.Contact() - pb_resp = service.Contact.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_contact(resp) - return resp - - class _ListContacts(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("ListContacts") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.ListContactsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> service.ListContactsResponse: - r"""Call the list contacts method over HTTP. - - Args: - request (~.service.ListContactsRequest): - The request object. Request message for the ListContacts - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.service.ListContactsResponse: - Response message for the ListContacts - method. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*}/contacts', - }, -{ - 'method': 'get', - 'uri': '/v1/{parent=folders/*}/contacts', - }, -{ - 'method': 'get', - 'uri': '/v1/{parent=organizations/*}/contacts', - }, - ] - request, metadata = self._interceptor.pre_list_contacts(request, metadata) - pb_request = service.ListContactsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = service.ListContactsResponse() - pb_resp = service.ListContactsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_contacts(resp) - return resp - - class _SendTestMessage(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("SendTestMessage") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.SendTestMessageRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the send test message method over HTTP. - - Args: - request (~.service.SendTestMessageRequest): - The request object. Request message for the - SendTestMessage method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{resource=projects/*}/contacts:sendTestMessage', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v1/{resource=folders/*}/contacts:sendTestMessage', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v1/{resource=organizations/*}/contacts:sendTestMessage', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_send_test_message(request, metadata) - pb_request = service.SendTestMessageRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _UpdateContact(EssentialContactsServiceRestStub): - def __hash__(self): - return hash("UpdateContact") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: service.UpdateContactRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> service.Contact: - r"""Call the update contact method over HTTP. - - Args: - request (~.service.UpdateContactRequest): - The request object. Request message for the UpdateContact - method. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.service.Contact: - A contact that will receive - notifications from Google Cloud. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{contact.name=projects/*/contacts/*}', - 'body': 'contact', - }, -{ - 'method': 'patch', - 'uri': '/v1/{contact.name=folders/*/contacts/*}', - 'body': 'contact', - }, -{ - 'method': 'patch', - 'uri': '/v1/{contact.name=organizations/*/contacts/*}', - 'body': 'contact', - }, - ] - request, metadata = self._interceptor.pre_update_contact(request, metadata) - pb_request = service.UpdateContactRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = service.Contact() - pb_resp = service.Contact.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_contact(resp) - return resp - - @property - def compute_contacts(self) -> Callable[ - [service.ComputeContactsRequest], - service.ComputeContactsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ComputeContacts(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_contact(self) -> Callable[ - [service.CreateContactRequest], - service.Contact]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._CreateContact(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_contact(self) -> Callable[ - [service.DeleteContactRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteContact(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_contact(self) -> Callable[ - [service.GetContactRequest], - service.Contact]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetContact(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_contacts(self) -> Callable[ - [service.ListContactsRequest], - service.ListContactsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListContacts(self._session, self._host, self._interceptor) # type: ignore - - @property - def send_test_message(self) -> Callable[ - [service.SendTestMessageRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SendTestMessage(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_contact(self) -> Callable[ - [service.UpdateContactRequest], - service.Contact]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateContact(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'EssentialContactsServiceRestTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py deleted file mode 100644 index c67f7ab..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/__init__.py +++ /dev/null @@ -1,42 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .service import ( - ComputeContactsRequest, - ComputeContactsResponse, - Contact, - CreateContactRequest, - DeleteContactRequest, - GetContactRequest, - ListContactsRequest, - ListContactsResponse, - SendTestMessageRequest, - UpdateContactRequest, -) - -__all__ = ( - 'NotificationCategory', - 'ValidationState', - 'ComputeContactsRequest', - 'ComputeContactsResponse', - 'Contact', - 'CreateContactRequest', - 'DeleteContactRequest', - 'GetContactRequest', - 'ListContactsRequest', - 'ListContactsResponse', - 'SendTestMessageRequest', - 'UpdateContactRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py deleted file mode 100644 index aff7b88..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/enums.py +++ /dev/null @@ -1,104 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.essentialcontacts.v1', - manifest={ - 'NotificationCategory', - 'ValidationState', - }, -) - - -class NotificationCategory(proto.Enum): - r"""The notification categories that an essential contact can be - subscribed to. Each notification will be categorized by the - sender into one of the following categories. All contacts that - are subscribed to that category will receive the notification. - - Values: - NOTIFICATION_CATEGORY_UNSPECIFIED (0): - Notification category is unrecognized or - unspecified. - ALL (2): - All notifications related to the resource, - including notifications pertaining to categories - added in the future. - SUSPENSION (3): - Notifications related to imminent account - suspension. - SECURITY (5): - Notifications related to security/privacy - incidents, notifications, and vulnerabilities. - TECHNICAL (6): - Notifications related to technical events and - issues such as outages, errors, or bugs. - BILLING (7): - Notifications related to billing and payments - notifications, price updates, errors, or - credits. - LEGAL (8): - Notifications related to enforcement actions, - regulatory compliance, or government notices. - PRODUCT_UPDATES (9): - Notifications related to new versions, - product terms updates, or deprecations. - TECHNICAL_INCIDENTS (10): - Child category of TECHNICAL. If assigned, - technical incident notifications will go to - these contacts instead of TECHNICAL. - """ - NOTIFICATION_CATEGORY_UNSPECIFIED = 0 - ALL = 2 - SUSPENSION = 3 - SECURITY = 5 - TECHNICAL = 6 - BILLING = 7 - LEGAL = 8 - PRODUCT_UPDATES = 9 - TECHNICAL_INCIDENTS = 10 - - -class ValidationState(proto.Enum): - r"""A contact's validation state indicates whether or not it is - the correct contact to be receiving notifications for a - particular resource. - - Values: - VALIDATION_STATE_UNSPECIFIED (0): - The validation state is unknown or - unspecified. - VALID (1): - The contact is marked as valid. This is - usually done manually by the contact admin. All - new contacts begin in the valid state. - INVALID (2): - The contact is considered invalid. This may - become the state if the contact's email is found - to be unreachable. - """ - VALIDATION_STATE_UNSPECIFIED = 0 - VALID = 1 - INVALID = 2 - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py b/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py deleted file mode 100644 index 3c3e8b2..0000000 --- a/owl-bot-staging/v1/google/cloud/essential_contacts_v1/types/service.py +++ /dev/null @@ -1,367 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.cloud.essential_contacts_v1.types import enums -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.essentialcontacts.v1', - manifest={ - 'Contact', - 'ListContactsRequest', - 'ListContactsResponse', - 'GetContactRequest', - 'DeleteContactRequest', - 'CreateContactRequest', - 'UpdateContactRequest', - 'ComputeContactsRequest', - 'ComputeContactsResponse', - 'SendTestMessageRequest', - }, -) - - -class Contact(proto.Message): - r"""A contact that will receive notifications from Google Cloud. - - Attributes: - name (str): - The identifier for the contact. Format: - {resource_type}/{resource_id}/contacts/{contact_id} - email (str): - Required. The email address to send - notifications to. This does not need to be a - Google account. - notification_category_subscriptions (MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]): - The categories of notifications that the - contact will receive communications for. - language_tag (str): - The preferred language for notifications, as a ISO 639-1 - language code. See `Supported - languages `__ - for a list of supported languages. - validation_state (google.cloud.essential_contacts_v1.types.ValidationState): - The validity of the contact. A contact is - considered valid if it is the correct recipient - for notifications for a particular resource. - validate_time (google.protobuf.timestamp_pb2.Timestamp): - The last time the validation_state was updated, either - manually or automatically. A contact is considered stale if - its validation state was updated more than 1 year ago. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - email: str = proto.Field( - proto.STRING, - number=2, - ) - notification_category_subscriptions: MutableSequence[enums.NotificationCategory] = proto.RepeatedField( - proto.ENUM, - number=3, - enum=enums.NotificationCategory, - ) - language_tag: str = proto.Field( - proto.STRING, - number=4, - ) - validation_state: enums.ValidationState = proto.Field( - proto.ENUM, - number=8, - enum=enums.ValidationState, - ) - validate_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - - -class ListContactsRequest(proto.Message): - r"""Request message for the ListContacts method. - - Attributes: - parent (str): - Required. The parent resource name. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - page_size (int): - Optional. The maximum number of results to return from this - request. Non-positive values are ignored. The presence of - ``next_page_token`` in the response indicates that more - results might be available. If not specified, the default - page_size is 100. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters should be - identical to those in the previous call. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - - -class ListContactsResponse(proto.Message): - r"""Response message for the ListContacts method. - - Attributes: - contacts (MutableSequence[google.cloud.essential_contacts_v1.types.Contact]): - The contacts for the specified resource. - next_page_token (str): - If there are more results than those appearing in this - response, then ``next_page_token`` is included. To get the - next set of results, call this method again using the value - of ``next_page_token`` as ``page_token`` and the rest of the - parameters the same as the original request. - """ - - @property - def raw_page(self): - return self - - contacts: MutableSequence['Contact'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Contact', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetContactRequest(proto.Message): - r"""Request message for the GetContact method. - - Attributes: - name (str): - Required. The name of the contact to retrieve. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteContactRequest(proto.Message): - r"""Request message for the DeleteContact method. - - Attributes: - name (str): - Required. The name of the contact to delete. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class CreateContactRequest(proto.Message): - r"""Request message for the CreateContact method. - - Attributes: - parent (str): - Required. The resource to save this contact for. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - contact (google.cloud.essential_contacts_v1.types.Contact): - Required. The contact to create. Must specify - an email address and language tag. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - contact: 'Contact' = proto.Field( - proto.MESSAGE, - number=2, - message='Contact', - ) - - -class UpdateContactRequest(proto.Message): - r"""Request message for the UpdateContact method. - - Attributes: - contact (google.cloud.essential_contacts_v1.types.Contact): - Required. The contact resource to replace the - existing saved contact. Note: the email address - of the contact cannot be modified. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. The update mask applied to the resource. For the - ``FieldMask`` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - """ - - contact: 'Contact' = proto.Field( - proto.MESSAGE, - number=2, - message='Contact', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - - -class ComputeContactsRequest(proto.Message): - r"""Request message for the ComputeContacts method. - - Attributes: - parent (str): - Required. The name of the resource to compute contacts for. - Format: organizations/{organization_id}, folders/{folder_id} - or projects/{project_id} - notification_categories (MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]): - The categories of notifications to compute - contacts for. If ALL is included in this list, - contacts subscribed to any notification category - will be returned. - page_size (int): - Optional. The maximum number of results to return from this - request. Non-positive values are ignored. The presence of - ``next_page_token`` in the response indicates that more - results might be available. If not specified, the default - page_size is 100. - page_token (str): - Optional. If present, retrieves the next batch of results - from the preceding call to this method. ``page_token`` must - be the value of ``next_page_token`` from the previous - response. The values of other method parameters should be - identical to those in the previous call. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - notification_categories: MutableSequence[enums.NotificationCategory] = proto.RepeatedField( - proto.ENUM, - number=6, - enum=enums.NotificationCategory, - ) - page_size: int = proto.Field( - proto.INT32, - number=3, - ) - page_token: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ComputeContactsResponse(proto.Message): - r"""Response message for the ComputeContacts method. - - Attributes: - contacts (MutableSequence[google.cloud.essential_contacts_v1.types.Contact]): - All contacts for the resource that are - subscribed to the specified notification - categories, including contacts inherited from - any parent resources. - next_page_token (str): - If there are more results than those appearing in this - response, then ``next_page_token`` is included. To get the - next set of results, call this method again using the value - of ``next_page_token`` as ``page_token`` and the rest of the - parameters the same as the original request. - """ - - @property - def raw_page(self): - return self - - contacts: MutableSequence['Contact'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Contact', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SendTestMessageRequest(proto.Message): - r"""Request message for the SendTestMessage method. - - Attributes: - contacts (MutableSequence[str]): - Required. The list of names of the contacts to send a test - message to. Format: - organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - resource (str): - Required. The name of the resource to send the test message - for. All contacts must either be set directly on this - resource or inherited from another resource that is an - ancestor of this one. Format: - organizations/{organization_id}, folders/{folder_id} or - projects/{project_id} - notification_category (google.cloud.essential_contacts_v1.types.NotificationCategory): - Required. The notification category to send - the test message for. All contacts must be - subscribed to this category. - """ - - contacts: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - resource: str = proto.Field( - proto.STRING, - number=2, - ) - notification_category: enums.NotificationCategory = proto.Field( - proto.ENUM, - number=3, - enum=enums.NotificationCategory, - ) - - -__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 574c5ae..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 2b843b3..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/essential_contacts_v1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==4.0.1", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py deleted file mode 100644 index f4d254e..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ComputeContacts -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_compute_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ComputeContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.compute_contacts(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py deleted file mode 100644 index c740d86..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ComputeContacts -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_compute_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ComputeContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.compute_contacts(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py deleted file mode 100644 index 275adf4..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for CreateContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_create_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.CreateContactRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py deleted file mode 100644 index 630c0b8..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for CreateContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_create_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.CreateContactRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py deleted file mode 100644 index 80cfb88..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_delete_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.DeleteContactRequest( - name="name_value", - ) - - # Make the request - await client.delete_contact(request=request) - - -# [END essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py deleted file mode 100644 index 9d71f81..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_delete_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.DeleteContactRequest( - name="name_value", - ) - - # Make the request - client.delete_contact(request=request) - - -# [END essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py deleted file mode 100644 index 05aedb2..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_GetContact_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_get_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.GetContactRequest( - name="name_value", - ) - - # Make the request - response = await client.get_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_GetContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py deleted file mode 100644 index 5cc3af2..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_get_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.GetContactRequest( - name="name_value", - ) - - # Make the request - response = client.get_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py deleted file mode 100644 index 9230c27..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListContacts -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_list_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ListContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_contacts(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py deleted file mode 100644 index 0adda6d..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListContacts -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_list_contacts(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.ListContactsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_contacts(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py deleted file mode 100644 index f5779dc..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SendTestMessage -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_send_test_message(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.SendTestMessageRequest( - contacts=['contacts_value1', 'contacts_value2'], - resource="resource_value", - notification_category="TECHNICAL_INCIDENTS", - ) - - # Make the request - await client.send_test_message(request=request) - - -# [END essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py deleted file mode 100644 index 73837df..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SendTestMessage -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_send_test_message(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.SendTestMessageRequest( - contacts=['contacts_value1', 'contacts_value2'], - resource="resource_value", - notification_category="TECHNICAL_INCIDENTS", - ) - - # Make the request - client.send_test_message(request=request) - - -# [END essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py deleted file mode 100644 index 0255714..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -async def sample_update_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceAsyncClient() - - # Initialize request argument(s) - request = essential_contacts_v1.UpdateContactRequest( - ) - - # Make the request - response = await client.update_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py b/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py deleted file mode 100644 index a081f8f..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateContact -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-essential-contacts - - -# [START essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import essential_contacts_v1 - - -def sample_update_contact(): - # Create a client - client = essential_contacts_v1.EssentialContactsServiceClient() - - # Initialize request argument(s) - request = essential_contacts_v1.UpdateContactRequest( - ) - - # Make the request - response = client.update_contact(request=request) - - # Handle the response - print(response) - -# [END essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json deleted file mode 100644 index 489bc82..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.essentialcontacts.v1.json +++ /dev/null @@ -1,1130 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.essentialcontacts.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-cloud-essential-contacts", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.compute_contacts", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ComputeContacts", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "ComputeContacts" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.ComputeContactsRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager", - "shortName": "compute_contacts" - }, - "description": "Sample for ComputeContacts", - "file": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.compute_contacts", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ComputeContacts", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "ComputeContacts" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.ComputeContactsRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager", - "shortName": "compute_contacts" - }, - "description": "Sample for ComputeContacts", - "file": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ComputeContacts_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_compute_contacts_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.create_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.CreateContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "CreateContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.CreateContactRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "contact", - "type": "google.cloud.essential_contacts_v1.types.Contact" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "create_contact" - }, - "description": "Sample for CreateContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_CreateContact_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.create_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.CreateContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "CreateContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.CreateContactRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "contact", - "type": "google.cloud.essential_contacts_v1.types.Contact" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "create_contact" - }, - "description": "Sample for CreateContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_CreateContact_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_create_contact_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.delete_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.DeleteContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "DeleteContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.DeleteContactRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_contact" - }, - "description": "Sample for DeleteContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.delete_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.DeleteContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "DeleteContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.DeleteContactRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_contact" - }, - "description": "Sample for DeleteContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_DeleteContact_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_delete_contact_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.get_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.GetContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "GetContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.GetContactRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "get_contact" - }, - "description": "Sample for GetContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_GetContact_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.get_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.GetContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "GetContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.GetContactRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "get_contact" - }, - "description": "Sample for GetContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_GetContact_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_get_contact_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.list_contacts", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ListContacts", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "ListContacts" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.ListContactsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager", - "shortName": "list_contacts" - }, - "description": "Sample for ListContacts", - "file": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ListContacts_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.list_contacts", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.ListContacts", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "ListContacts" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.ListContactsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager", - "shortName": "list_contacts" - }, - "description": "Sample for ListContacts", - "file": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_ListContacts_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_list_contacts_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.send_test_message", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.SendTestMessage", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "SendTestMessage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.SendTestMessageRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "send_test_message" - }, - "description": "Sample for SendTestMessage", - "file": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.send_test_message", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.SendTestMessage", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "SendTestMessage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.SendTestMessageRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "send_test_message" - }, - "description": "Sample for SendTestMessage", - "file": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_SendTestMessage_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_send_test_message_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient", - "shortName": "EssentialContactsServiceAsyncClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceAsyncClient.update_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.UpdateContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "UpdateContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.UpdateContactRequest" - }, - { - "name": "contact", - "type": "google.cloud.essential_contacts_v1.types.Contact" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "update_contact" - }, - "description": "Sample for UpdateContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient", - "shortName": "EssentialContactsServiceClient" - }, - "fullName": "google.cloud.essential_contacts_v1.EssentialContactsServiceClient.update_contact", - "method": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService.UpdateContact", - "service": { - "fullName": "google.cloud.essentialcontacts.v1.EssentialContactsService", - "shortName": "EssentialContactsService" - }, - "shortName": "UpdateContact" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.essential_contacts_v1.types.UpdateContactRequest" - }, - { - "name": "contact", - "type": "google.cloud.essential_contacts_v1.types.Contact" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.essential_contacts_v1.types.Contact", - "shortName": "update_contact" - }, - "description": "Sample for UpdateContact", - "file": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "essentialcontacts_v1_generated_EssentialContactsService_UpdateContact_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "essentialcontacts_v1_generated_essential_contacts_service_update_contact_sync.py" - } - ] -} diff --git a/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py deleted file mode 100644 index 448c7a7..0000000 --- a/owl-bot-staging/v1/scripts/fixup_essential_contacts_v1_keywords.py +++ /dev/null @@ -1,182 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class essential_contactsCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'compute_contacts': ('parent', 'notification_categories', 'page_size', 'page_token', ), - 'create_contact': ('parent', 'contact', ), - 'delete_contact': ('name', ), - 'get_contact': ('name', ), - 'list_contacts': ('parent', 'page_size', 'page_token', ), - 'send_test_message': ('contacts', 'resource', 'notification_category', ), - 'update_contact': ('contact', '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: a.keyword.value not in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=essential_contactsCallTransformer(), -): - """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 essential_contacts 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 32b9698..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-essential-contacts' - - -description = "Google Cloud Essential Contacts API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/essential_contacts/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-essential-contacts" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py b/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py deleted file mode 100644 index 0d91123..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/essential_contacts_v1/test_essential_contacts_service.py +++ /dev/null @@ -1,4789 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.essential_contacts_v1.services.essential_contacts_service import EssentialContactsServiceAsyncClient -from google.cloud.essential_contacts_v1.services.essential_contacts_service import EssentialContactsServiceClient -from google.cloud.essential_contacts_v1.services.essential_contacts_service import pagers -from google.cloud.essential_contacts_v1.services.essential_contacts_service import transports -from google.cloud.essential_contacts_v1.types import enums -from google.cloud.essential_contacts_v1.types import service -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 - - -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 EssentialContactsServiceClient._get_default_mtls_endpoint(None) is None - assert EssentialContactsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert EssentialContactsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert EssentialContactsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert EssentialContactsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert EssentialContactsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (EssentialContactsServiceClient, "grpc"), - (EssentialContactsServiceAsyncClient, "grpc_asyncio"), - (EssentialContactsServiceClient, "rest"), -]) -def test_essential_contacts_service_client_from_service_account_info(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'essentialcontacts.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://essentialcontacts.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.EssentialContactsServiceGrpcTransport, "grpc"), - (transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.EssentialContactsServiceRestTransport, "rest"), -]) -def test_essential_contacts_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,transport_name", [ - (EssentialContactsServiceClient, "grpc"), - (EssentialContactsServiceAsyncClient, "grpc_asyncio"), - (EssentialContactsServiceClient, "rest"), -]) -def test_essential_contacts_service_client_from_service_account_file(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'essentialcontacts.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://essentialcontacts.googleapis.com' - ) - - -def test_essential_contacts_service_client_get_transport_class(): - transport = EssentialContactsServiceClient.get_transport_class() - available_transports = [ - transports.EssentialContactsServiceGrpcTransport, - transports.EssentialContactsServiceRestTransport, - ] - assert transport in available_transports - - transport = EssentialContactsServiceClient.get_transport_class("grpc") - assert transport == transports.EssentialContactsServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc"), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest"), -]) -@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) -@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) -def test_essential_contacts_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(EssentialContactsServiceClient, '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(EssentialContactsServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class(transport=transport_name) - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class(transport=transport_name) - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", "true"), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", "false"), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", "true"), - (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) -@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_essential_contacts_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, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class", [ - EssentialContactsServiceClient, EssentialContactsServiceAsyncClient -]) -@mock.patch.object(EssentialContactsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceClient)) -@mock.patch.object(EssentialContactsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(EssentialContactsServiceAsyncClient)) -def test_essential_contacts_service_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc"), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest"), -]) -def test_essential_contacts_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, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", grpc_helpers), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (EssentialContactsServiceClient, transports.EssentialContactsServiceRestTransport, "rest", None), -]) -def test_essential_contacts_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -def test_essential_contacts_service_client_client_options_from_dict(): - with mock.patch('google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = EssentialContactsServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport, "grpc", grpc_helpers), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_essential_contacts_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "essentialcontacts.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="essentialcontacts.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - service.CreateContactRequest, - dict, -]) -def test_create_contact(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - response = client.create_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_create_contact_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 = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - client.create_contact() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateContactRequest() - -@pytest.mark.asyncio -async def test_create_contact_async(transport: str = 'grpc_asyncio', request_type=service.CreateContactRequest): - client = EssentialContactsServiceAsyncClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - )) - response = await client.create_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.CreateContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -@pytest.mark.asyncio -async def test_create_contact_async_from_dict(): - await test_create_contact_async(request_type=dict) - - -def test_create_contact_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.CreateContactRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_contact), - '__call__') as call: - call.return_value = service.Contact() - client.create_contact(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_contact_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.CreateContactRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_contact), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - await client.create_contact(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_contact_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_contact( - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].contact - mock_val = service.Contact(name='name_value') - assert arg == mock_val - - -def test_create_contact_flattened_error(): - client = EssentialContactsServiceClient( - 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_contact( - service.CreateContactRequest(), - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_contact_flattened_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_contact( - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].contact - mock_val = service.Contact(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_contact_flattened_error_async(): - client = EssentialContactsServiceAsyncClient( - 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_contact( - service.CreateContactRequest(), - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - service.UpdateContactRequest, - dict, -]) -def test_update_contact(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - response = client.update_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_update_contact_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 = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - client.update_contact() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateContactRequest() - -@pytest.mark.asyncio -async def test_update_contact_async(transport: str = 'grpc_asyncio', request_type=service.UpdateContactRequest): - client = EssentialContactsServiceAsyncClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - )) - response = await client.update_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.UpdateContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -@pytest.mark.asyncio -async def test_update_contact_async_from_dict(): - await test_update_contact_async(request_type=dict) - - -def test_update_contact_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.UpdateContactRequest() - - request.contact.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_contact), - '__call__') as call: - call.return_value = service.Contact() - client.update_contact(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', - 'contact.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_contact_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.UpdateContactRequest() - - request.contact.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_contact), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - await client.update_contact(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', - 'contact.name=name_value', - ) in kw['metadata'] - - -def test_update_contact_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_contact( - contact=service.Contact(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] - arg = args[0].contact - mock_val = service.Contact(name='name_value') - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_update_contact_flattened_error(): - client = EssentialContactsServiceClient( - 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_contact( - service.UpdateContactRequest(), - contact=service.Contact(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_contact_flattened_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_contact( - contact=service.Contact(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] - arg = args[0].contact - mock_val = service.Contact(name='name_value') - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - -@pytest.mark.asyncio -async def test_update_contact_flattened_error_async(): - client = EssentialContactsServiceAsyncClient( - 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_contact( - service.UpdateContactRequest(), - contact=service.Contact(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - service.ListContactsRequest, - dict, -]) -def test_list_contacts(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListContactsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_contacts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListContactsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListContactsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_contacts_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 = EssentialContactsServiceClient( - 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_contacts), - '__call__') as call: - client.list_contacts() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListContactsRequest() - -@pytest.mark.asyncio -async def test_list_contacts_async(transport: str = 'grpc_asyncio', request_type=service.ListContactsRequest): - client = EssentialContactsServiceAsyncClient( - 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_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_contacts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.ListContactsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListContactsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_contacts_async_from_dict(): - await test_list_contacts_async(request_type=dict) - - -def test_list_contacts_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.ListContactsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - call.return_value = service.ListContactsResponse() - client.list_contacts(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_contacts_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.ListContactsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse()) - await client.list_contacts(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_contacts_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListContactsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_contacts( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - - -def test_list_contacts_flattened_error(): - client = EssentialContactsServiceClient( - 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_contacts( - service.ListContactsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_contacts_flattened_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ListContactsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ListContactsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_contacts( - parent='parent_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_list_contacts_flattened_error_async(): - client = EssentialContactsServiceAsyncClient( - 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_contacts( - service.ListContactsRequest(), - parent='parent_value', - ) - - -def test_list_contacts_pager(transport_name: str = "grpc"): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ListContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_contacts(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, service.Contact) - for i in results) -def test_list_contacts_pages(transport_name: str = "grpc"): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ListContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - pages = list(client.list_contacts(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_contacts_async_pager(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ListContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_contacts(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, service.Contact) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_contacts_async_pages(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_contacts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ListContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_contacts(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - service.GetContactRequest, - dict, -]) -def test_get_contact(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - response = client.get_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_get_contact_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 = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - client.get_contact() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetContactRequest() - -@pytest.mark.asyncio -async def test_get_contact_async(transport: str = 'grpc_asyncio', request_type=service.GetContactRequest): - client = EssentialContactsServiceAsyncClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - )) - response = await client.get_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.GetContactRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -@pytest.mark.asyncio -async def test_get_contact_async_from_dict(): - await test_get_contact_async(request_type=dict) - - -def test_get_contact_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.GetContactRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_contact), - '__call__') as call: - call.return_value = service.Contact() - client.get_contact(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_contact_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.GetContactRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_contact), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - await client.get_contact(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_contact_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_contact( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_get_contact_flattened_error(): - client = EssentialContactsServiceClient( - 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_contact( - service.GetContactRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_contact_flattened_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.Contact() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.Contact()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_contact( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_contact_flattened_error_async(): - client = EssentialContactsServiceAsyncClient( - 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_contact( - service.GetContactRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - service.DeleteContactRequest, - dict, -]) -def test_delete_contact(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteContactRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_contact_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 = EssentialContactsServiceClient( - 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_contact), - '__call__') as call: - client.delete_contact() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteContactRequest() - -@pytest.mark.asyncio -async def test_delete_contact_async(transport: str = 'grpc_asyncio', request_type=service.DeleteContactRequest): - client = EssentialContactsServiceAsyncClient( - 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_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_contact(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.DeleteContactRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_contact_async_from_dict(): - await test_delete_contact_async(request_type=dict) - - -def test_delete_contact_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.DeleteContactRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_contact), - '__call__') as call: - call.return_value = None - client.delete_contact(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_contact_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.DeleteContactRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_contact), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_contact(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_contact_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_contact( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_delete_contact_flattened_error(): - client = EssentialContactsServiceClient( - 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_contact( - service.DeleteContactRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_contact_flattened_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_contact), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_contact( - name='name_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_delete_contact_flattened_error_async(): - client = EssentialContactsServiceAsyncClient( - 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_contact( - service.DeleteContactRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - service.ComputeContactsRequest, - dict, -]) -def test_compute_contacts(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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.compute_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = service.ComputeContactsResponse( - next_page_token='next_page_token_value', - ) - response = client.compute_contacts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.ComputeContactsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ComputeContactsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_compute_contacts_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 = EssentialContactsServiceClient( - 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.compute_contacts), - '__call__') as call: - client.compute_contacts() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.ComputeContactsRequest() - -@pytest.mark.asyncio -async def test_compute_contacts_async(transport: str = 'grpc_asyncio', request_type=service.ComputeContactsRequest): - client = EssentialContactsServiceAsyncClient( - 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.compute_contacts), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(service.ComputeContactsResponse( - next_page_token='next_page_token_value', - )) - response = await client.compute_contacts(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.ComputeContactsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ComputeContactsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_compute_contacts_async_from_dict(): - await test_compute_contacts_async(request_type=dict) - - -def test_compute_contacts_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.ComputeContactsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__') as call: - call.return_value = service.ComputeContactsResponse() - client.compute_contacts(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_compute_contacts_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.ComputeContactsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(service.ComputeContactsResponse()) - await client.compute_contacts(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_compute_contacts_pager(transport_name: str = "grpc"): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ComputeContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.compute_contacts(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, service.Contact) - for i in results) -def test_compute_contacts_pages(transport_name: str = "grpc"): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ComputeContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - pages = list(client.compute_contacts(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_compute_contacts_async_pager(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ComputeContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - async_pager = await client.compute_contacts(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, service.Contact) - for i in responses) - - -@pytest.mark.asyncio -async def test_compute_contacts_async_pages(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.compute_contacts), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ComputeContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.compute_contacts(request={})).pages: # pragma: no branch - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - service.SendTestMessageRequest, - dict, -]) -def test_send_test_message(request_type, transport: str = 'grpc'): - client = EssentialContactsServiceClient( - 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.send_test_message), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.send_test_message(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == service.SendTestMessageRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_send_test_message_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 = EssentialContactsServiceClient( - 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.send_test_message), - '__call__') as call: - client.send_test_message() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == service.SendTestMessageRequest() - -@pytest.mark.asyncio -async def test_send_test_message_async(transport: str = 'grpc_asyncio', request_type=service.SendTestMessageRequest): - client = EssentialContactsServiceAsyncClient( - 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.send_test_message), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.send_test_message(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == service.SendTestMessageRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_send_test_message_async_from_dict(): - await test_send_test_message_async(request_type=dict) - - -def test_send_test_message_field_headers(): - client = EssentialContactsServiceClient( - 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 = service.SendTestMessageRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.send_test_message), - '__call__') as call: - call.return_value = None - client.send_test_message(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_send_test_message_field_headers_async(): - client = EssentialContactsServiceAsyncClient( - 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 = service.SendTestMessageRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.send_test_message), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.send_test_message(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.parametrize("request_type", [ - service.CreateContactRequest, - dict, -]) -def test_create_contact_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request_init["contact"] = {'name': 'name_value', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.create_contact(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_create_contact_rest_required_fields(request_type=service.CreateContactRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = service.Contact() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.create_contact(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_contact_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_contact._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "contact", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_contact_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_create_contact") as post, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_create_contact") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = service.CreateContactRequest.pb(service.CreateContactRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = service.Contact.to_json(service.Contact()) - - request = service.CreateContactRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = service.Contact() - - client.create_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_create_contact_rest_bad_request(transport: str = 'rest', request_type=service.CreateContactRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request_init["contact"] = {'name': 'name_value', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.create_contact(request) - - -def test_create_contact_rest_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.create_contact(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{parent=projects/*}/contacts" % client.transport._host, args[1]) - - -def test_create_contact_rest_flattened_error(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_contact( - service.CreateContactRequest(), - parent='parent_value', - contact=service.Contact(name='name_value'), - ) - - -def test_create_contact_rest_error(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - service.UpdateContactRequest, - dict, -]) -def test_update_contact_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'contact': {'name': 'projects/sample1/contacts/sample2'}} - request_init["contact"] = {'name': 'projects/sample1/contacts/sample2', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_contact(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_update_contact_rest_required_fields(request_type=service.UpdateContactRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_contact._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("update_mask", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = service.Contact() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "patch", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_contact(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_contact_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_contact._get_unset_required_fields({}) - assert set(unset_fields) == (set(("updateMask", )) & set(("contact", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_contact_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_update_contact") as post, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_update_contact") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = service.UpdateContactRequest.pb(service.UpdateContactRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = service.Contact.to_json(service.Contact()) - - request = service.UpdateContactRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = service.Contact() - - client.update_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_contact_rest_bad_request(transport: str = 'rest', request_type=service.UpdateContactRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'contact': {'name': 'projects/sample1/contacts/sample2'}} - request_init["contact"] = {'name': 'projects/sample1/contacts/sample2', 'email': 'email_value', 'notification_category_subscriptions': [2], 'language_tag': 'language_tag_value', 'validation_state': 1, 'validate_time': {'seconds': 751, 'nanos': 543}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_contact(request) - - -def test_update_contact_rest_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact() - - # get arguments that satisfy an http rule for this method - sample_request = {'contact': {'name': 'projects/sample1/contacts/sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - contact=service.Contact(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_contact(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{contact.name=projects/*/contacts/*}" % client.transport._host, args[1]) - - -def test_update_contact_rest_flattened_error(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_contact( - service.UpdateContactRequest(), - contact=service.Contact(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_update_contact_rest_error(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - service.ListContactsRequest, - dict, -]) -def test_list_contacts_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.ListContactsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.ListContactsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_contacts(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListContactsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_contacts_rest_required_fields(request_type=service.ListContactsRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_contacts._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_contacts._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("page_size", "page_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = service.ListContactsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = service.ListContactsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_contacts(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_contacts_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_contacts._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_contacts_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_list_contacts") as post, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_list_contacts") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = service.ListContactsRequest.pb(service.ListContactsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = service.ListContactsResponse.to_json(service.ListContactsResponse()) - - request = service.ListContactsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = service.ListContactsResponse() - - client.list_contacts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_contacts_rest_bad_request(transport: str = 'rest', request_type=service.ListContactsRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_contacts(request) - - -def test_list_contacts_rest_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.ListContactsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.ListContactsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_contacts(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{parent=projects/*}/contacts" % client.transport._host, args[1]) - - -def test_list_contacts_rest_flattened_error(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_contacts( - service.ListContactsRequest(), - parent='parent_value', - ) - - -def test_list_contacts_rest_pager(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ListContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ListContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(service.ListContactsResponse.to_json(x) for x in response) - return_values = tuple(Response() for i in response) - for return_val, response_val in zip(return_values, response): - return_val._content = response_val.encode('UTF-8') - return_val.status_code = 200 - req.side_effect = return_values - - sample_request = {'parent': 'projects/sample1'} - - pager = client.list_contacts(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, service.Contact) - for i in results) - - pages = list(client.list_contacts(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - service.GetContactRequest, - dict, -]) -def test_get_contact_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/contacts/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact( - name='name_value', - email='email_value', - notification_category_subscriptions=[enums.NotificationCategory.ALL], - language_tag='language_tag_value', - validation_state=enums.ValidationState.VALID, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_contact(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, service.Contact) - assert response.name == 'name_value' - assert response.email == 'email_value' - assert response.notification_category_subscriptions == [enums.NotificationCategory.ALL] - assert response.language_tag == 'language_tag_value' - assert response.validation_state == enums.ValidationState.VALID - - -def test_get_contact_rest_required_fields(request_type=service.GetContactRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = service.Contact() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_contact(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_contact_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_contact._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_contact_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_get_contact") as post, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_get_contact") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = service.GetContactRequest.pb(service.GetContactRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = service.Contact.to_json(service.Contact()) - - request = service.GetContactRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = service.Contact() - - client.get_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_contact_rest_bad_request(transport: str = 'rest', request_type=service.GetContactRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/contacts/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_contact(request) - - -def test_get_contact_rest_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.Contact() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/contacts/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.Contact.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_contact(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{name=projects/*/contacts/*}" % client.transport._host, args[1]) - - -def test_get_contact_rest_flattened_error(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_contact( - service.GetContactRequest(), - name='name_value', - ) - - -def test_get_contact_rest_error(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - service.DeleteContactRequest, - dict, -]) -def test_delete_contact_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/contacts/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_contact(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_contact_rest_required_fields(request_type=service.DeleteContactRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_contact._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_contact(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_contact_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_contact._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_contact_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_delete_contact") as pre: - pre.assert_not_called() - pb_message = service.DeleteContactRequest.pb(service.DeleteContactRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = service.DeleteContactRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_contact(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_contact_rest_bad_request(transport: str = 'rest', request_type=service.DeleteContactRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/contacts/sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_contact(request) - - -def test_delete_contact_rest_flattened(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/contacts/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_contact(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v1/{name=projects/*/contacts/*}" % client.transport._host, args[1]) - - -def test_delete_contact_rest_flattened_error(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_contact( - service.DeleteContactRequest(), - name='name_value', - ) - - -def test_delete_contact_rest_error(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - service.ComputeContactsRequest, - dict, -]) -def test_compute_contacts_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = service.ComputeContactsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = service.ComputeContactsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.compute_contacts(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ComputeContactsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_compute_contacts_rest_required_fields(request_type=service.ComputeContactsRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).compute_contacts._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).compute_contacts._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("notification_categories", "page_size", "page_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = service.ComputeContactsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = service.ComputeContactsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.compute_contacts(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_compute_contacts_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.compute_contacts._get_unset_required_fields({}) - assert set(unset_fields) == (set(("notificationCategories", "pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_compute_contacts_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "post_compute_contacts") as post, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_compute_contacts") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = service.ComputeContactsRequest.pb(service.ComputeContactsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = service.ComputeContactsResponse.to_json(service.ComputeContactsResponse()) - - request = service.ComputeContactsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = service.ComputeContactsResponse() - - client.compute_contacts(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_compute_contacts_rest_bad_request(transport: str = 'rest', request_type=service.ComputeContactsRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.compute_contacts(request) - - -def test_compute_contacts_rest_pager(transport: str = 'rest'): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - service.Contact(), - ], - next_page_token='abc', - ), - service.ComputeContactsResponse( - contacts=[], - next_page_token='def', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - ], - next_page_token='ghi', - ), - service.ComputeContactsResponse( - contacts=[ - service.Contact(), - service.Contact(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(service.ComputeContactsResponse.to_json(x) for x in response) - return_values = tuple(Response() for i in response) - for return_val, response_val in zip(return_values, response): - return_val._content = response_val.encode('UTF-8') - return_val.status_code = 200 - req.side_effect = return_values - - sample_request = {'parent': 'projects/sample1'} - - pager = client.compute_contacts(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, service.Contact) - for i in results) - - pages = list(client.compute_contacts(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - service.SendTestMessageRequest, - dict, -]) -def test_send_test_message_rest(request_type): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.send_test_message(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_send_test_message_rest_required_fields(request_type=service.SendTestMessageRequest): - transport_class = transports.EssentialContactsServiceRestTransport - - request_init = {} - request_init["contacts"] = "" - request_init["resource"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).send_test_message._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["contacts"] = 'contacts_value' - jsonified_request["resource"] = 'resource_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).send_test_message._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "contacts" in jsonified_request - assert jsonified_request["contacts"] == 'contacts_value' - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.send_test_message(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_send_test_message_rest_unset_required_fields(): - transport = transports.EssentialContactsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.send_test_message._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("contacts", "resource", "notificationCategory", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_send_test_message_rest_interceptors(null_interceptor): - transport = transports.EssentialContactsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.EssentialContactsServiceRestInterceptor(), - ) - client = EssentialContactsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.EssentialContactsServiceRestInterceptor, "pre_send_test_message") as pre: - pre.assert_not_called() - pb_message = service.SendTestMessageRequest.pb(service.SendTestMessageRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = service.SendTestMessageRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.send_test_message(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_send_test_message_rest_bad_request(transport: str = 'rest', request_type=service.SendTestMessageRequest): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.send_test_message(request) - - -def test_send_test_message_rest_error(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = EssentialContactsServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = EssentialContactsServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = EssentialContactsServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = EssentialContactsServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = EssentialContactsServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.EssentialContactsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.EssentialContactsServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.EssentialContactsServiceGrpcTransport, - transports.EssentialContactsServiceGrpcAsyncIOTransport, - transports.EssentialContactsServiceRestTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = EssentialContactsServiceClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.EssentialContactsServiceGrpcTransport, - ) - -def test_essential_contacts_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.EssentialContactsServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_essential_contacts_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.EssentialContactsServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_contact', - 'update_contact', - 'list_contacts', - 'get_contact', - 'delete_contact', - 'compute_contacts', - 'send_test_message', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_essential_contacts_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.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.EssentialContactsServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_essential_contacts_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.essential_contacts_v1.services.essential_contacts_service.transports.EssentialContactsServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.EssentialContactsServiceTransport() - adc.assert_called_once() - - -def test_essential_contacts_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) - EssentialContactsServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.EssentialContactsServiceGrpcTransport, - transports.EssentialContactsServiceGrpcAsyncIOTransport, - ], -) -def test_essential_contacts_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.EssentialContactsServiceGrpcTransport, - transports.EssentialContactsServiceGrpcAsyncIOTransport, - transports.EssentialContactsServiceRestTransport, - ], -) -def test_essential_contacts_service_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.EssentialContactsServiceGrpcTransport, grpc_helpers), - (transports.EssentialContactsServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_essential_contacts_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( - "essentialcontacts.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="essentialcontacts.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) -def test_essential_contacts_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_essential_contacts_service_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.EssentialContactsServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_essential_contacts_service_host_no_port(transport_name): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='essentialcontacts.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'essentialcontacts.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://essentialcontacts.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_essential_contacts_service_host_with_port(transport_name): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='essentialcontacts.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'essentialcontacts.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://essentialcontacts.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_essential_contacts_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = EssentialContactsServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = EssentialContactsServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.create_contact._session - session2 = client2.transport.create_contact._session - assert session1 != session2 - session1 = client1.transport.update_contact._session - session2 = client2.transport.update_contact._session - assert session1 != session2 - session1 = client1.transport.list_contacts._session - session2 = client2.transport.list_contacts._session - assert session1 != session2 - session1 = client1.transport.get_contact._session - session2 = client2.transport.get_contact._session - assert session1 != session2 - session1 = client1.transport.delete_contact._session - session2 = client2.transport.delete_contact._session - assert session1 != session2 - session1 = client1.transport.compute_contacts._session - session2 = client2.transport.compute_contacts._session - assert session1 != session2 - session1 = client1.transport.send_test_message._session - session2 = client2.transport.send_test_message._session - assert session1 != session2 -def test_essential_contacts_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.EssentialContactsServiceGrpcTransport( - 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_essential_contacts_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.EssentialContactsServiceGrpcAsyncIOTransport( - 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.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) -def test_essential_contacts_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.EssentialContactsServiceGrpcTransport, transports.EssentialContactsServiceGrpcAsyncIOTransport]) -def test_essential_contacts_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_contact_path(): - project = "squid" - contact = "clam" - expected = "projects/{project}/contacts/{contact}".format(project=project, contact=contact, ) - actual = EssentialContactsServiceClient.contact_path(project, contact) - assert expected == actual - - -def test_parse_contact_path(): - expected = { - "project": "whelk", - "contact": "octopus", - } - path = EssentialContactsServiceClient.contact_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_contact_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "oyster" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = EssentialContactsServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "nudibranch", - } - path = EssentialContactsServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "cuttlefish" - expected = "folders/{folder}".format(folder=folder, ) - actual = EssentialContactsServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "mussel", - } - path = EssentialContactsServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "winkle" - expected = "organizations/{organization}".format(organization=organization, ) - actual = EssentialContactsServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nautilus", - } - path = EssentialContactsServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "scallop" - expected = "projects/{project}".format(project=project, ) - actual = EssentialContactsServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "abalone", - } - path = EssentialContactsServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "squid" - location = "clam" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = EssentialContactsServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "whelk", - "location": "octopus", - } - path = EssentialContactsServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = EssentialContactsServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_with_default_client_info(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.EssentialContactsServiceTransport, '_prep_wrapped_messages') as prep: - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.EssentialContactsServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = EssentialContactsServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = EssentialContactsServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - - -def test_transport_close(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'rest', - 'grpc', - ] - for transport in transports: - client = EssentialContactsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - # Test client calls underlying transport. - with mock.patch.object(type(client.transport), "close") as close: - close.assert_not_called() - with client: - pass - close.assert_called() - -@pytest.mark.parametrize("client_class,transport_class", [ - (EssentialContactsServiceClient, transports.EssentialContactsServiceGrpcTransport), - (EssentialContactsServiceAsyncClient, transports.EssentialContactsServiceGrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - )