From 9739f2a98fca381c5a46386b8234034424e0354f Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:04:25 +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 ++ owl-bot-staging/v1/docs/index.rst | 7 + .../recaptcha_enterprise_service.rst | 10 + .../docs/recaptchaenterprise_v1/services.rst | 6 + .../v1/docs/recaptchaenterprise_v1/types.rst | 6 + .../cloud/recaptchaenterprise/__init__.py | 111 + .../recaptchaenterprise/gapic_version.py | 16 + .../google/cloud/recaptchaenterprise/py.typed | 2 + .../cloud/recaptchaenterprise_v1/__init__.py | 112 + .../gapic_metadata.json | 153 + .../recaptchaenterprise_v1/gapic_version.py | 16 + .../cloud/recaptchaenterprise_v1/py.typed | 2 + .../services/__init__.py | 15 + .../recaptcha_enterprise_service/__init__.py | 22 + .../async_client.py | 1623 ++++++ .../recaptcha_enterprise_service/client.py | 1862 ++++++ .../recaptcha_enterprise_service/pagers.py | 502 ++ .../transports/__init__.py | 33 + .../transports/base.py | 317 ++ .../transports/grpc.py | 592 ++ .../transports/grpc_asyncio.py | 591 ++ .../recaptchaenterprise_v1/types/__init__.py | 104 + .../types/recaptchaenterprise.py | 2232 ++++++++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 184 + ...prise_service_annotate_assessment_async.py | 52 + ...rprise_service_annotate_assessment_sync.py | 52 + ...erprise_service_create_assessment_async.py | 52 + ...terprise_service_create_assessment_sync.py | 52 + ...cha_enterprise_service_create_key_async.py | 56 + ...tcha_enterprise_service_create_key_sync.py | 56 + ...cha_enterprise_service_delete_key_async.py | 50 + ...tcha_enterprise_service_delete_key_sync.py | 50 + ...aptcha_enterprise_service_get_key_async.py | 52 + ...captcha_enterprise_service_get_key_sync.py | 52 + ...ha_enterprise_service_get_metrics_async.py | 52 + ...cha_enterprise_service_get_metrics_sync.py | 52 + ...tcha_enterprise_service_list_keys_async.py | 53 + ...ptcha_enterprise_service_list_keys_sync.py | 53 + ...related_account_group_memberships_async.py | 53 + ..._related_account_group_memberships_sync.py | 53 + ...rvice_list_related_account_groups_async.py | 53 + ...ervice_list_related_account_groups_sync.py | 53 + ...ha_enterprise_service_migrate_key_async.py | 52 + ...cha_enterprise_service_migrate_key_sync.py | 52 + ...ervice_retrieve_legacy_secret_key_async.py | 52 + ...service_retrieve_legacy_secret_key_sync.py | 52 + ...related_account_group_memberships_async.py | 53 + ..._related_account_group_memberships_sync.py | 53 + ...cha_enterprise_service_update_key_async.py | 55 + ...tcha_enterprise_service_update_key_sync.py | 55 + ...a_google.cloud.recaptchaenterprise.v1.json | 2134 +++++++ .../fixup_recaptchaenterprise_v1_keywords.py | 188 + 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/recaptchaenterprise_v1/__init__.py | 16 + .../test_recaptcha_enterprise_service.py | 4996 +++++++++++++++++ 69 files changed, 17875 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/index.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.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/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json create mode 100644 owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_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/recaptchaenterprise_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..a3d09d1 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/recaptchaenterprise/__init__.py + google/cloud/recaptchaenterprise/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..2ebaff4 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/recaptchaenterprise *.py +recursive-include google/cloud/recaptchaenterprise_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..dd39e48 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Recaptchaenterprise 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 Recaptchaenterprise 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..6dba3e7 --- /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-recaptcha-enterprise 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-recaptcha-enterprise" +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-recaptcha-enterprise-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-recaptcha-enterprise.tex", + u"google-cloud-recaptcha-enterprise 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-recaptcha-enterprise", + u"Google Cloud Recaptchaenterprise 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-recaptcha-enterprise", + u"google-cloud-recaptcha-enterprise Documentation", + author, + "google-cloud-recaptcha-enterprise", + "GAPIC library for Google Cloud Recaptchaenterprise API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..35c60ea --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + recaptchaenterprise_v1/services + recaptchaenterprise_v1/types diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst new file mode 100644 index 0000000..5031186 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst @@ -0,0 +1,10 @@ +RecaptchaEnterpriseService +-------------------------------------------- + +.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service + :members: + :inherited-members: + +.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst new file mode 100644 index 0000000..4211502 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Recaptchaenterprise v1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + recaptcha_enterprise_service diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst new file mode 100644 index 0000000..788d8d5 --- /dev/null +++ b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Recaptchaenterprise v1 API +================================================= + +.. automodule:: google.cloud.recaptchaenterprise_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py new file mode 100644 index 0000000..0d1d2de --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py @@ -0,0 +1,111 @@ +# -*- 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.recaptchaenterprise import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.client import RecaptchaEnterpriseServiceClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.async_client import RecaptchaEnterpriseServiceAsyncClient + +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AccountDefenderAssessment +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AccountVerificationInfo +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AndroidKeySettings +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Assessment +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ChallengeMetrics +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateAssessmentRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import DeleteKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import EndpointVerificationInfo +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Event +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import FraudPreventionAssessment +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetMetricsRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import IOSKeySettings +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Key +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupMembershipsRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupMembershipsResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupsRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupsResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Metrics +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import MigrateKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import PrivatePasswordLeakVerification +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RelatedAccountGroup +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RelatedAccountGroupMembership +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RetrieveLegacySecretKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RetrieveLegacySecretKeyResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RiskAnalysis +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ScoreDistribution +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ScoreMetrics +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsResponse +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TestingOptions +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TokenProperties +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TransactionData +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TransactionEvent +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import UpdateKeyRequest +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WafSettings +from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WebKeySettings + +__all__ = ('RecaptchaEnterpriseServiceClient', + 'RecaptchaEnterpriseServiceAsyncClient', + 'AccountDefenderAssessment', + 'AccountVerificationInfo', + 'AndroidKeySettings', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'Assessment', + 'ChallengeMetrics', + 'CreateAssessmentRequest', + 'CreateKeyRequest', + 'DeleteKeyRequest', + 'EndpointVerificationInfo', + 'Event', + 'FraudPreventionAssessment', + 'GetKeyRequest', + 'GetMetricsRequest', + 'IOSKeySettings', + 'Key', + 'ListKeysRequest', + 'ListKeysResponse', + 'ListRelatedAccountGroupMembershipsRequest', + 'ListRelatedAccountGroupMembershipsResponse', + 'ListRelatedAccountGroupsRequest', + 'ListRelatedAccountGroupsResponse', + 'Metrics', + 'MigrateKeyRequest', + 'PrivatePasswordLeakVerification', + 'RelatedAccountGroup', + 'RelatedAccountGroupMembership', + 'RetrieveLegacySecretKeyRequest', + 'RetrieveLegacySecretKeyResponse', + 'RiskAnalysis', + 'ScoreDistribution', + 'ScoreMetrics', + 'SearchRelatedAccountGroupMembershipsRequest', + 'SearchRelatedAccountGroupMembershipsResponse', + 'TestingOptions', + 'TokenProperties', + 'TransactionData', + 'TransactionEvent', + 'UpdateKeyRequest', + 'WafSettings', + 'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/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/recaptchaenterprise/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed new file mode 100644 index 0000000..2c6a51a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recaptcha-enterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py new file mode 100644 index 0000000..056a970 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py @@ -0,0 +1,112 @@ +# -*- 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.recaptchaenterprise_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient +from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient + +from .types.recaptchaenterprise import AccountDefenderAssessment +from .types.recaptchaenterprise import AccountVerificationInfo +from .types.recaptchaenterprise import AndroidKeySettings +from .types.recaptchaenterprise import AnnotateAssessmentRequest +from .types.recaptchaenterprise import AnnotateAssessmentResponse +from .types.recaptchaenterprise import Assessment +from .types.recaptchaenterprise import ChallengeMetrics +from .types.recaptchaenterprise import CreateAssessmentRequest +from .types.recaptchaenterprise import CreateKeyRequest +from .types.recaptchaenterprise import DeleteKeyRequest +from .types.recaptchaenterprise import EndpointVerificationInfo +from .types.recaptchaenterprise import Event +from .types.recaptchaenterprise import FraudPreventionAssessment +from .types.recaptchaenterprise import GetKeyRequest +from .types.recaptchaenterprise import GetMetricsRequest +from .types.recaptchaenterprise import IOSKeySettings +from .types.recaptchaenterprise import Key +from .types.recaptchaenterprise import ListKeysRequest +from .types.recaptchaenterprise import ListKeysResponse +from .types.recaptchaenterprise import ListRelatedAccountGroupMembershipsRequest +from .types.recaptchaenterprise import ListRelatedAccountGroupMembershipsResponse +from .types.recaptchaenterprise import ListRelatedAccountGroupsRequest +from .types.recaptchaenterprise import ListRelatedAccountGroupsResponse +from .types.recaptchaenterprise import Metrics +from .types.recaptchaenterprise import MigrateKeyRequest +from .types.recaptchaenterprise import PrivatePasswordLeakVerification +from .types.recaptchaenterprise import RelatedAccountGroup +from .types.recaptchaenterprise import RelatedAccountGroupMembership +from .types.recaptchaenterprise import RetrieveLegacySecretKeyRequest +from .types.recaptchaenterprise import RetrieveLegacySecretKeyResponse +from .types.recaptchaenterprise import RiskAnalysis +from .types.recaptchaenterprise import ScoreDistribution +from .types.recaptchaenterprise import ScoreMetrics +from .types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsRequest +from .types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsResponse +from .types.recaptchaenterprise import TestingOptions +from .types.recaptchaenterprise import TokenProperties +from .types.recaptchaenterprise import TransactionData +from .types.recaptchaenterprise import TransactionEvent +from .types.recaptchaenterprise import UpdateKeyRequest +from .types.recaptchaenterprise import WafSettings +from .types.recaptchaenterprise import WebKeySettings + +__all__ = ( + 'RecaptchaEnterpriseServiceAsyncClient', +'AccountDefenderAssessment', +'AccountVerificationInfo', +'AndroidKeySettings', +'AnnotateAssessmentRequest', +'AnnotateAssessmentResponse', +'Assessment', +'ChallengeMetrics', +'CreateAssessmentRequest', +'CreateKeyRequest', +'DeleteKeyRequest', +'EndpointVerificationInfo', +'Event', +'FraudPreventionAssessment', +'GetKeyRequest', +'GetMetricsRequest', +'IOSKeySettings', +'Key', +'ListKeysRequest', +'ListKeysResponse', +'ListRelatedAccountGroupMembershipsRequest', +'ListRelatedAccountGroupMembershipsResponse', +'ListRelatedAccountGroupsRequest', +'ListRelatedAccountGroupsResponse', +'Metrics', +'MigrateKeyRequest', +'PrivatePasswordLeakVerification', +'RecaptchaEnterpriseServiceClient', +'RelatedAccountGroup', +'RelatedAccountGroupMembership', +'RetrieveLegacySecretKeyRequest', +'RetrieveLegacySecretKeyResponse', +'RiskAnalysis', +'ScoreDistribution', +'ScoreMetrics', +'SearchRelatedAccountGroupMembershipsRequest', +'SearchRelatedAccountGroupMembershipsResponse', +'TestingOptions', +'TokenProperties', +'TransactionData', +'TransactionEvent', +'UpdateKeyRequest', +'WafSettings', +'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json new file mode 100644 index 0000000..c44d903 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json @@ -0,0 +1,153 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.recaptchaenterprise_v1", + "protoPackage": "google.cloud.recaptchaenterprise.v1", + "schema": "1.0", + "services": { + "RecaptchaEnterpriseService": { + "clients": { + "grpc": { + "libraryClient": "RecaptchaEnterpriseServiceClient", + "rpcs": { + "AnnotateAssessment": { + "methods": [ + "annotate_assessment" + ] + }, + "CreateAssessment": { + "methods": [ + "create_assessment" + ] + }, + "CreateKey": { + "methods": [ + "create_key" + ] + }, + "DeleteKey": { + "methods": [ + "delete_key" + ] + }, + "GetKey": { + "methods": [ + "get_key" + ] + }, + "GetMetrics": { + "methods": [ + "get_metrics" + ] + }, + "ListKeys": { + "methods": [ + "list_keys" + ] + }, + "ListRelatedAccountGroupMemberships": { + "methods": [ + "list_related_account_group_memberships" + ] + }, + "ListRelatedAccountGroups": { + "methods": [ + "list_related_account_groups" + ] + }, + "MigrateKey": { + "methods": [ + "migrate_key" + ] + }, + "RetrieveLegacySecretKey": { + "methods": [ + "retrieve_legacy_secret_key" + ] + }, + "SearchRelatedAccountGroupMemberships": { + "methods": [ + "search_related_account_group_memberships" + ] + }, + "UpdateKey": { + "methods": [ + "update_key" + ] + } + } + }, + "grpc-async": { + "libraryClient": "RecaptchaEnterpriseServiceAsyncClient", + "rpcs": { + "AnnotateAssessment": { + "methods": [ + "annotate_assessment" + ] + }, + "CreateAssessment": { + "methods": [ + "create_assessment" + ] + }, + "CreateKey": { + "methods": [ + "create_key" + ] + }, + "DeleteKey": { + "methods": [ + "delete_key" + ] + }, + "GetKey": { + "methods": [ + "get_key" + ] + }, + "GetMetrics": { + "methods": [ + "get_metrics" + ] + }, + "ListKeys": { + "methods": [ + "list_keys" + ] + }, + "ListRelatedAccountGroupMemberships": { + "methods": [ + "list_related_account_group_memberships" + ] + }, + "ListRelatedAccountGroups": { + "methods": [ + "list_related_account_groups" + ] + }, + "MigrateKey": { + "methods": [ + "migrate_key" + ] + }, + "RetrieveLegacySecretKey": { + "methods": [ + "retrieve_legacy_secret_key" + ] + }, + "SearchRelatedAccountGroupMemberships": { + "methods": [ + "search_related_account_group_memberships" + ] + }, + "UpdateKey": { + "methods": [ + "update_key" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_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/recaptchaenterprise_v1/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed new file mode 100644 index 0000000..2c6a51a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-recaptcha-enterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_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/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py new file mode 100644 index 0000000..d017ca6 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_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 RecaptchaEnterpriseServiceClient +from .async_client import RecaptchaEnterpriseServiceAsyncClient + +__all__ = ( + 'RecaptchaEnterpriseServiceClient', + 'RecaptchaEnterpriseServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py new file mode 100644 index 0000000..316d8f2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py @@ -0,0 +1,1623 @@ +# -*- 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.recaptchaenterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport +from .client import RecaptchaEnterpriseServiceClient + + +class RecaptchaEnterpriseServiceAsyncClient: + """Service to determine the likelihood an event is legitimate.""" + + _client: RecaptchaEnterpriseServiceClient + + DEFAULT_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_MTLS_ENDPOINT + + assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.assessment_path) + parse_assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_assessment_path) + key_path = staticmethod(RecaptchaEnterpriseServiceClient.key_path) + parse_key_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_key_path) + metrics_path = staticmethod(RecaptchaEnterpriseServiceClient.metrics_path) + parse_metrics_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_metrics_path) + related_account_group_path = staticmethod(RecaptchaEnterpriseServiceClient.related_account_group_path) + parse_related_account_group_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_related_account_group_path) + related_account_group_membership_path = staticmethod(RecaptchaEnterpriseServiceClient.related_account_group_membership_path) + parse_related_account_group_membership_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_related_account_group_membership_path) + common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_organization_path) + common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.common_project_path) + parse_common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_project_path) + common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.common_location_path) + parse_common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.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: + RecaptchaEnterpriseServiceAsyncClient: The constructed client. + """ + return RecaptchaEnterpriseServiceClient.from_service_account_info.__func__(RecaptchaEnterpriseServiceAsyncClient, 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: + RecaptchaEnterpriseServiceAsyncClient: The constructed client. + """ + return RecaptchaEnterpriseServiceClient.from_service_account_file.__func__(RecaptchaEnterpriseServiceAsyncClient, 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 RecaptchaEnterpriseServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> RecaptchaEnterpriseServiceTransport: + """Returns the transport used by the client instance. + + Returns: + RecaptchaEnterpriseServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(RecaptchaEnterpriseServiceClient).get_transport_class, type(RecaptchaEnterpriseServiceClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, RecaptchaEnterpriseServiceTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recaptcha enterprise 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, ~.RecaptchaEnterpriseServiceTransport]): 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 = RecaptchaEnterpriseServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_assessment(self, + request: Optional[Union[recaptchaenterprise.CreateAssessmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + assessment: Optional[recaptchaenterprise.Assessment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Assessment: + r"""Creates an Assessment of the likelihood an event is + legitimate. + + .. 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 recaptchaenterprise_v1 + + async def sample_create_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.CreateAssessmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_assessment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]]): + The request object. The create assessment request + message. + parent (:class:`str`): + Required. The name of the project in + which the assessment will be created, in + the format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assessment (:class:`google.cloud.recaptchaenterprise_v1.types.Assessment`): + Required. The assessment details. + This corresponds to the ``assessment`` 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.recaptchaenterprise_v1.types.Assessment: + A reCAPTCHA Enterprise assessment + resource. + + """ + # 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, assessment]) + 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 = recaptchaenterprise.CreateAssessmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assessment is not None: + request.assessment = assessment + + # 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_assessment, + default_timeout=600.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 annotate_assessment(self, + request: Optional[Union[recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, + *, + name: Optional[str] = None, + annotation: Optional[recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.AnnotateAssessmentResponse: + r"""Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fraudulent. + + .. 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 recaptchaenterprise_v1 + + async def sample_annotate_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.AnnotateAssessmentRequest( + name="name_value", + ) + + # Make the request + response = await client.annotate_assessment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]]): + The request object. The request message to annotate an + Assessment. + name (:class:`str`): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`): + Optional. The annotation that will be + assigned to the Event. This field can be + left empty to provide reasons that apply + to an event without concluding whether + the event is legitimate or fraudulent. + + This corresponds to the ``annotation`` 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.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: + Empty response for + AnnotateAssessment. + + """ + # 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, annotation]) + 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 = recaptchaenterprise.AnnotateAssessmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if annotation is not None: + request.annotation = annotation + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.annotate_assessment, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_key(self, + request: Optional[Union[recaptchaenterprise.CreateKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + key: Optional[recaptchaenterprise.Key] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Creates a new reCAPTCHA Enterprise key. + + .. 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 recaptchaenterprise_v1 + + async def sample_create_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.CreateKeyRequest( + parent="parent_value", + key=key, + ) + + # Make the request + response = await client.create_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]]): + The request object. The create key request message. + parent (:class:`str`): + Required. The name of the project in + which the key will be created, in the + format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + key (:class:`google.cloud.recaptchaenterprise_v1.types.Key`): + Required. Information to create a + reCAPTCHA Enterprise key. + + This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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, key]) + 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 = recaptchaenterprise.CreateKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if key is not None: + request.key = key + + # 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_key, + default_timeout=600.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 list_keys(self, + request: Optional[Union[recaptchaenterprise.ListKeysRequest, 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.ListKeysAsyncPager: + r"""Returns the list of all keys that belong to a + project. + + .. 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 recaptchaenterprise_v1 + + async def sample_list_keys(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListKeysRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_keys(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]]): + The request object. The list keys request message. + parent (:class:`str`): + Required. The name of the project + that contains the keys that will be + listed, in the format + "projects/{project}". + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager: + Response to request to list keys in a + project. + 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 = recaptchaenterprise.ListKeysRequest(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_keys, + default_timeout=600.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.ListKeysAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def retrieve_legacy_secret_key(self, + request: Optional[Union[recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, + *, + key: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.RetrieveLegacySecretKeyResponse: + r"""Returns the secret key related to the specified + public key. You must use the legacy secret key only in a + 3rd party integration with legacy reCAPTCHA. + + .. 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 recaptchaenterprise_v1 + + async def sample_retrieve_legacy_secret_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( + key="key_value", + ) + + # Make the request + response = await client.retrieve_legacy_secret_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]]): + The request object. The retrieve legacy secret key + request message. + key (:class:`str`): + Required. The public key name linked + to the requested secret key in the + format "projects/{project}/keys/{key}". + + This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse: + Secret key is used only in legacy + reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. + + """ + # 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([key]) + 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if key is not None: + request.key = key + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.retrieve_legacy_secret_key, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("key", request.key), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_key(self, + request: Optional[Union[recaptchaenterprise.GetKeyRequest, 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]] = (), + ) -> recaptchaenterprise.Key: + r"""Returns the specified key. + + .. 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 recaptchaenterprise_v1 + + async def sample_get_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.get_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]]): + The request object. The get key request message. + name (:class:`str`): + Required. The name of the requested + key, in the format + "projects/{project}/keys/{key}". + + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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 = recaptchaenterprise.GetKeyRequest(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_key, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_key(self, + request: Optional[Union[recaptchaenterprise.UpdateKeyRequest, dict]] = None, + *, + key: Optional[recaptchaenterprise.Key] = 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]] = (), + ) -> recaptchaenterprise.Key: + r"""Updates the specified key. + + .. 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 recaptchaenterprise_v1 + + async def sample_update_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.UpdateKeyRequest( + key=key, + ) + + # Make the request + response = await client.update_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]]): + The request object. The update key request message. + key (:class:`google.cloud.recaptchaenterprise_v1.types.Key`): + Required. The key to update. + This corresponds to the ``key`` 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 mask to control which + fields of the key get updated. If the + mask is not present, all fields will be + updated. + + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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([key, 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 = recaptchaenterprise.UpdateKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if key is not None: + request.key = key + 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_key, + default_timeout=600.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(( + ("key.name", request.key.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_key(self, + request: Optional[Union[recaptchaenterprise.DeleteKeyRequest, 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 the specified key. + + .. 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 recaptchaenterprise_v1 + + async def sample_delete_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.DeleteKeyRequest( + name="name_value", + ) + + # Make the request + await client.delete_key(request=request) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]]): + The request object. The delete key request message. + name (:class:`str`): + Required. The name of the key to be + deleted, in the format + "projects/{project}/keys/{key}". + + 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 = recaptchaenterprise.DeleteKeyRequest(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_key, + default_timeout=600.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 migrate_key(self, + request: Optional[Union[recaptchaenterprise.MigrateKeyRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Migrates an existing key from reCAPTCHA to reCAPTCHA + Enterprise. Once a key is migrated, it can be used from + either product. SiteVerify requests are billed as + CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Site Key, and + your user must have the reCAPTCHA Enterprise Admin IAM + role in the destination project. + + .. 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 recaptchaenterprise_v1 + + async def sample_migrate_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.MigrateKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.migrate_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]]): + The request object. The migrate key request message. + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + request = recaptchaenterprise.MigrateKeyRequest(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.migrate_key, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_metrics(self, + request: Optional[Union[recaptchaenterprise.GetMetricsRequest, 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]] = (), + ) -> recaptchaenterprise.Metrics: + r"""Get some aggregated metrics for a Key. This data can + be used to build dashboards. + + .. 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 recaptchaenterprise_v1 + + async def sample_get_metrics(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetMetricsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_metrics(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]]): + The request object. The get metrics request message. + name (:class:`str`): + Required. The name of the requested + metrics, in the format + "projects/{project}/keys/{key}/metrics". + + 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.recaptchaenterprise_v1.types.Metrics: + Metrics for a single Key. + """ + # 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 = recaptchaenterprise.GetMetricsRequest(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_metrics, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_related_account_groups(self, + request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupsRequest, 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.ListRelatedAccountGroupsAsyncPager: + r"""List groups of related accounts. + + .. 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 recaptchaenterprise_v1 + + async def sample_list_related_account_groups(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_groups(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]]): + The request object. The request message to list related + account groups. + parent (:class:`str`): + Required. The name of the project to + list related account groups from, in the + format "projects/{project}". + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager: + The response to a ListRelatedAccountGroups call. + + 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(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_related_account_groups, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRelatedAccountGroupsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_related_account_group_memberships(self, + request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, 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.ListRelatedAccountGroupMembershipsAsyncPager: + r"""Get memberships in a group of related accounts. + + .. 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 recaptchaenterprise_v1 + + async def sample_list_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_group_memberships(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]]): + The request object. The request message to list + memberships in a related account group. + parent (:class:`str`): + Required. The resource name for the related account + group in the format + ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager: + The response to a ListRelatedAccountGroupMemberships + call. + + 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(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_related_account_group_memberships, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRelatedAccountGroupMembershipsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def search_related_account_group_memberships(self, + request: Optional[Union[recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, + *, + project: Optional[str] = None, + hashed_account_id: Optional[bytes] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchRelatedAccountGroupMembershipsAsyncPager: + r"""Search group memberships related to a given account. + + .. 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 recaptchaenterprise_v1 + + async def sample_search_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( + project="project_value", + ) + + # Make the request + page_result = client.search_related_account_group_memberships(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]]): + The request object. The request message to search related + account group memberships. + project (:class:`str`): + Required. The name of the project to + search related account group memberships + from. Specify the project name in the + following format: "projects/{project}". + + This corresponds to the ``project`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hashed_account_id (:class:`bytes`): + Optional. The unique stable hashed user identifier we + should search connections to. The identifier should + correspond to a ``hashed_account_id`` provided in a + previous ``CreateAssessment`` or ``AnnotateAssessment`` + call. + + This corresponds to the ``hashed_account_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager: + The response to a SearchRelatedAccountGroupMemberships + call. + + 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([project, hashed_account_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if project is not None: + request.project = project + if hashed_account_id is not None: + request.hashed_account_id = hashed_account_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.search_related_account_group_memberships, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("project", request.project), + )), + ) + + # 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.SearchRelatedAccountGroupMembershipsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "RecaptchaEnterpriseServiceAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py new file mode 100644 index 0000000..3460a98 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py @@ -0,0 +1,1862 @@ +# -*- 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.recaptchaenterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import RecaptchaEnterpriseServiceGrpcTransport +from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + +class RecaptchaEnterpriseServiceClientMeta(type): + """Metaclass for the RecaptchaEnterpriseService 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[RecaptchaEnterpriseServiceTransport]] + _transport_registry["grpc"] = RecaptchaEnterpriseServiceGrpcTransport + _transport_registry["grpc_asyncio"] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[RecaptchaEnterpriseServiceTransport]: + """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 RecaptchaEnterpriseServiceClient(metaclass=RecaptchaEnterpriseServiceClientMeta): + """Service to determine the likelihood an event is legitimate.""" + + @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 = "recaptchaenterprise.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: + RecaptchaEnterpriseServiceClient: 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: + RecaptchaEnterpriseServiceClient: 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) -> RecaptchaEnterpriseServiceTransport: + """Returns the transport used by the client instance. + + Returns: + RecaptchaEnterpriseServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def assessment_path(project: str,assessment: str,) -> str: + """Returns a fully-qualified assessment string.""" + return "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) + + @staticmethod + def parse_assessment_path(path: str) -> Dict[str,str]: + """Parses a assessment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/assessments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def key_path(project: str,key: str,) -> str: + """Returns a fully-qualified key string.""" + return "projects/{project}/keys/{key}".format(project=project, key=key, ) + + @staticmethod + def parse_key_path(path: str) -> Dict[str,str]: + """Parses a key path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def metrics_path(project: str,key: str,) -> str: + """Returns a fully-qualified metrics string.""" + return "projects/{project}/keys/{key}/metrics".format(project=project, key=key, ) + + @staticmethod + def parse_metrics_path(path: str) -> Dict[str,str]: + """Parses a metrics path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)/metrics$", path) + return m.groupdict() if m else {} + + @staticmethod + def related_account_group_path(project: str,relatedaccountgroup: str,) -> str: + """Returns a fully-qualified related_account_group string.""" + return "projects/{project}/relatedaccountgroups/{relatedaccountgroup}".format(project=project, relatedaccountgroup=relatedaccountgroup, ) + + @staticmethod + def parse_related_account_group_path(path: str) -> Dict[str,str]: + """Parses a related_account_group path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/relatedaccountgroups/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def related_account_group_membership_path(project: str,relatedaccountgroup: str,membership: str,) -> str: + """Returns a fully-qualified related_account_group_membership string.""" + return "projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}".format(project=project, relatedaccountgroup=relatedaccountgroup, membership=membership, ) + + @staticmethod + def parse_related_account_group_membership_path(path: str) -> Dict[str,str]: + """Parses a related_account_group_membership path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/relatedaccountgroups/(?P.+?)/memberships/(?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, RecaptchaEnterpriseServiceTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the recaptcha enterprise 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, RecaptchaEnterpriseServiceTransport]): 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, RecaptchaEnterpriseServiceTransport): + # transport is a RecaptchaEnterpriseServiceTransport 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_assessment(self, + request: Optional[Union[recaptchaenterprise.CreateAssessmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + assessment: Optional[recaptchaenterprise.Assessment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Assessment: + r"""Creates an Assessment of the likelihood an event is + legitimate. + + .. 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 recaptchaenterprise_v1 + + def sample_create_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.CreateAssessmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_assessment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]): + The request object. The create assessment request + message. + parent (str): + Required. The name of the project in + which the assessment will be created, in + the format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): + Required. The assessment details. + This corresponds to the ``assessment`` 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.recaptchaenterprise_v1.types.Assessment: + A reCAPTCHA Enterprise assessment + resource. + + """ + # 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, assessment]) + 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 recaptchaenterprise.CreateAssessmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.CreateAssessmentRequest): + request = recaptchaenterprise.CreateAssessmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assessment is not None: + request.assessment = assessment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_assessment] + + # 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 annotate_assessment(self, + request: Optional[Union[recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, + *, + name: Optional[str] = None, + annotation: Optional[recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.AnnotateAssessmentResponse: + r"""Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fraudulent. + + .. 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 recaptchaenterprise_v1 + + def sample_annotate_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.AnnotateAssessmentRequest( + name="name_value", + ) + + # Make the request + response = client.annotate_assessment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]): + The request object. The request message to annotate an + Assessment. + name (str): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): + Optional. The annotation that will be + assigned to the Event. This field can be + left empty to provide reasons that apply + to an event without concluding whether + the event is legitimate or fraudulent. + + This corresponds to the ``annotation`` 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.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: + Empty response for + AnnotateAssessment. + + """ + # 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, annotation]) + 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 recaptchaenterprise.AnnotateAssessmentRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.AnnotateAssessmentRequest): + request = recaptchaenterprise.AnnotateAssessmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if annotation is not None: + request.annotation = annotation + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.annotate_assessment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_key(self, + request: Optional[Union[recaptchaenterprise.CreateKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + key: Optional[recaptchaenterprise.Key] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Creates a new reCAPTCHA Enterprise key. + + .. 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 recaptchaenterprise_v1 + + def sample_create_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.CreateKeyRequest( + parent="parent_value", + key=key, + ) + + # Make the request + response = client.create_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]): + The request object. The create key request message. + parent (str): + Required. The name of the project in + which the key will be created, in the + format "projects/{project}". + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. Information to create a + reCAPTCHA Enterprise key. + + This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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, key]) + 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 recaptchaenterprise.CreateKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.CreateKeyRequest): + request = recaptchaenterprise.CreateKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if key is not None: + request.key = key + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_key] + + # 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 list_keys(self, + request: Optional[Union[recaptchaenterprise.ListKeysRequest, 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.ListKeysPager: + r"""Returns the list of all keys that belong to a + project. + + .. 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 recaptchaenterprise_v1 + + def sample_list_keys(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListKeysRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_keys(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]): + The request object. The list keys request message. + parent (str): + Required. The name of the project + that contains the keys that will be + listed, in the format + "projects/{project}". + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager: + Response to request to list keys in a + project. + 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 recaptchaenterprise.ListKeysRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.ListKeysRequest): + request = recaptchaenterprise.ListKeysRequest(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_keys] + + # 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.ListKeysPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def retrieve_legacy_secret_key(self, + request: Optional[Union[recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, + *, + key: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.RetrieveLegacySecretKeyResponse: + r"""Returns the secret key related to the specified + public key. You must use the legacy secret key only in a + 3rd party integration with legacy reCAPTCHA. + + .. 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 recaptchaenterprise_v1 + + def sample_retrieve_legacy_secret_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( + key="key_value", + ) + + # Make the request + response = client.retrieve_legacy_secret_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]): + The request object. The retrieve legacy secret key + request message. + key (str): + Required. The public key name linked + to the requested secret key in the + format "projects/{project}/keys/{key}". + + This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse: + Secret key is used only in legacy + reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. + + """ + # 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([key]) + 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 recaptchaenterprise.RetrieveLegacySecretKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.RetrieveLegacySecretKeyRequest): + request = recaptchaenterprise.RetrieveLegacySecretKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if key is not None: + request.key = key + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.retrieve_legacy_secret_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("key", request.key), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_key(self, + request: Optional[Union[recaptchaenterprise.GetKeyRequest, 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]] = (), + ) -> recaptchaenterprise.Key: + r"""Returns the specified key. + + .. 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 recaptchaenterprise_v1 + + def sample_get_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetKeyRequest( + name="name_value", + ) + + # Make the request + response = client.get_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]): + The request object. The get key request message. + name (str): + Required. The name of the requested + key, in the format + "projects/{project}/keys/{key}". + + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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 recaptchaenterprise.GetKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.GetKeyRequest): + request = recaptchaenterprise.GetKeyRequest(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_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_key(self, + request: Optional[Union[recaptchaenterprise.UpdateKeyRequest, dict]] = None, + *, + key: Optional[recaptchaenterprise.Key] = 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]] = (), + ) -> recaptchaenterprise.Key: + r"""Updates the specified key. + + .. 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 recaptchaenterprise_v1 + + def sample_update_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.UpdateKeyRequest( + key=key, + ) + + # Make the request + response = client.update_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]): + The request object. The update key request message. + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. The key to update. + This corresponds to the ``key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The mask to control which + fields of the key get updated. If the + mask is not present, all fields will be + updated. + + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # 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([key, 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 recaptchaenterprise.UpdateKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.UpdateKeyRequest): + request = recaptchaenterprise.UpdateKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if key is not None: + request.key = key + 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_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("key.name", request.key.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_key(self, + request: Optional[Union[recaptchaenterprise.DeleteKeyRequest, 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 the specified key. + + .. 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 recaptchaenterprise_v1 + + def sample_delete_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.DeleteKeyRequest( + name="name_value", + ) + + # Make the request + client.delete_key(request=request) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]): + The request object. The delete key request message. + name (str): + Required. The name of the key to be + deleted, in the format + "projects/{project}/keys/{key}". + + 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 recaptchaenterprise.DeleteKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.DeleteKeyRequest): + request = recaptchaenterprise.DeleteKeyRequest(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_key] + + # 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 migrate_key(self, + request: Optional[Union[recaptchaenterprise.MigrateKeyRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recaptchaenterprise.Key: + r"""Migrates an existing key from reCAPTCHA to reCAPTCHA + Enterprise. Once a key is migrated, it can be used from + either product. SiteVerify requests are billed as + CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Site Key, and + your user must have the reCAPTCHA Enterprise Admin IAM + role in the destination project. + + .. 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 recaptchaenterprise_v1 + + def sample_migrate_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.MigrateKeyRequest( + name="name_value", + ) + + # Make the request + response = client.migrate_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]): + The request object. The migrate key request message. + 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.recaptchaenterprise_v1.types.Key: + A key used to identify and configure + applications (web and/or mobile) that + use reCAPTCHA Enterprise. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.MigrateKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.MigrateKeyRequest): + request = recaptchaenterprise.MigrateKeyRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.migrate_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_metrics(self, + request: Optional[Union[recaptchaenterprise.GetMetricsRequest, 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]] = (), + ) -> recaptchaenterprise.Metrics: + r"""Get some aggregated metrics for a Key. This data can + be used to build dashboards. + + .. 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 recaptchaenterprise_v1 + + def sample_get_metrics(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetMetricsRequest( + name="name_value", + ) + + # Make the request + response = client.get_metrics(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]): + The request object. The get metrics request message. + name (str): + Required. The name of the requested + metrics, in the format + "projects/{project}/keys/{key}/metrics". + + 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.recaptchaenterprise_v1.types.Metrics: + Metrics for a single Key. + """ + # 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 recaptchaenterprise.GetMetricsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.GetMetricsRequest): + request = recaptchaenterprise.GetMetricsRequest(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_metrics] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_related_account_groups(self, + request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupsRequest, 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.ListRelatedAccountGroupsPager: + r"""List groups of related accounts. + + .. 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 recaptchaenterprise_v1 + + def sample_list_related_account_groups(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_groups(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]): + The request object. The request message to list related + account groups. + parent (str): + Required. The name of the project to + list related account groups from, in the + format "projects/{project}". + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager: + The response to a ListRelatedAccountGroups call. + + 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 recaptchaenterprise.ListRelatedAccountGroupsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.ListRelatedAccountGroupsRequest): + request = recaptchaenterprise.ListRelatedAccountGroupsRequest(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_related_account_groups] + + # 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.ListRelatedAccountGroupsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_related_account_group_memberships(self, + request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, 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.ListRelatedAccountGroupMembershipsPager: + r"""Get memberships in a group of related accounts. + + .. 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 recaptchaenterprise_v1 + + def sample_list_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_group_memberships(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]): + The request object. The request message to list + memberships in a related account group. + parent (str): + Required. The resource name for the related account + group in the format + ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. + + 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager: + The response to a ListRelatedAccountGroupMemberships + call. + + 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 recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest): + request = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(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_related_account_group_memberships] + + # 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.ListRelatedAccountGroupMembershipsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def search_related_account_group_memberships(self, + request: Optional[Union[recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, + *, + project: Optional[str] = None, + hashed_account_id: Optional[bytes] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.SearchRelatedAccountGroupMembershipsPager: + r"""Search group memberships related to a given account. + + .. 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 recaptchaenterprise_v1 + + def sample_search_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( + project="project_value", + ) + + # Make the request + page_result = client.search_related_account_group_memberships(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]): + The request object. The request message to search related + account group memberships. + project (str): + Required. The name of the project to + search related account group memberships + from. Specify the project name in the + following format: "projects/{project}". + + This corresponds to the ``project`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hashed_account_id (bytes): + Optional. The unique stable hashed user identifier we + should search connections to. The identifier should + correspond to a ``hashed_account_id`` provided in a + previous ``CreateAssessment`` or ``AnnotateAssessment`` + call. + + This corresponds to the ``hashed_account_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager: + The response to a SearchRelatedAccountGroupMemberships + call. + + 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([project, hashed_account_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest): + request = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if project is not None: + request.project = project + if hashed_account_id is not None: + request.hashed_account_id = hashed_account_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_related_account_group_memberships] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("project", request.project), + )), + ) + + # 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.SearchRelatedAccountGroupMembershipsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "RecaptchaEnterpriseServiceClient": + 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__ = ( + "RecaptchaEnterpriseServiceClient", +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py new file mode 100644 index 0000000..6ceb7f5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py @@ -0,0 +1,502 @@ +# -*- 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.recaptchaenterprise_v1.types import recaptchaenterprise + + +class ListKeysPager: + """A pager for iterating through ``list_keys`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and + provides an ``__iter__`` method to iterate through its + ``keys`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListKeys`` requests and continue to iterate + through the ``keys`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` + 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[..., recaptchaenterprise.ListKeysResponse], + request: recaptchaenterprise.ListKeysRequest, + response: recaptchaenterprise.ListKeysResponse, + *, + 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.recaptchaenterprise_v1.types.ListKeysRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): + 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 = recaptchaenterprise.ListKeysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[recaptchaenterprise.ListKeysResponse]: + 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[recaptchaenterprise.Key]: + for page in self.pages: + yield from page.keys + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListKeysAsyncPager: + """A pager for iterating through ``list_keys`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``keys`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListKeys`` requests and continue to iterate + through the ``keys`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` + 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[recaptchaenterprise.ListKeysResponse]], + request: recaptchaenterprise.ListKeysRequest, + response: recaptchaenterprise.ListKeysResponse, + *, + 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.recaptchaenterprise_v1.types.ListKeysRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): + 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 = recaptchaenterprise.ListKeysRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[recaptchaenterprise.ListKeysResponse]: + 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[recaptchaenterprise.Key]: + async def async_generator(): + async for page in self.pages: + for response in page.keys: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRelatedAccountGroupsPager: + """A pager for iterating through ``list_related_account_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``related_account_groups`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRelatedAccountGroups`` requests and continue to iterate + through the ``related_account_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` + 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[..., recaptchaenterprise.ListRelatedAccountGroupsResponse], + request: recaptchaenterprise.ListRelatedAccountGroupsRequest, + response: recaptchaenterprise.ListRelatedAccountGroupsResponse, + *, + 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse): + 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[recaptchaenterprise.ListRelatedAccountGroupsResponse]: + 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[recaptchaenterprise.RelatedAccountGroup]: + for page in self.pages: + yield from page.related_account_groups + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRelatedAccountGroupsAsyncPager: + """A pager for iterating through ``list_related_account_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``related_account_groups`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRelatedAccountGroups`` requests and continue to iterate + through the ``related_account_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` + 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[recaptchaenterprise.ListRelatedAccountGroupsResponse]], + request: recaptchaenterprise.ListRelatedAccountGroupsRequest, + response: recaptchaenterprise.ListRelatedAccountGroupsResponse, + *, + 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse): + 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[recaptchaenterprise.ListRelatedAccountGroupsResponse]: + 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[recaptchaenterprise.RelatedAccountGroup]: + async def async_generator(): + async for page in self.pages: + for response in page.related_account_groups: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRelatedAccountGroupMembershipsPager: + """A pager for iterating through ``list_related_account_group_memberships`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``related_account_group_memberships`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRelatedAccountGroupMemberships`` requests and continue to iterate + through the ``related_account_group_memberships`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` + 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[..., recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse], + request: recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, + response: recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, + *, + 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse): + 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: + 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[recaptchaenterprise.RelatedAccountGroupMembership]: + for page in self.pages: + yield from page.related_account_group_memberships + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRelatedAccountGroupMembershipsAsyncPager: + """A pager for iterating through ``list_related_account_group_memberships`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``related_account_group_memberships`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRelatedAccountGroupMemberships`` requests and continue to iterate + through the ``related_account_group_memberships`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` + 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[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]], + request: recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, + response: recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, + *, + 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse): + 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: + 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[recaptchaenterprise.RelatedAccountGroupMembership]: + async def async_generator(): + async for page in self.pages: + for response in page.related_account_group_memberships: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchRelatedAccountGroupMembershipsPager: + """A pager for iterating through ``search_related_account_group_memberships`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``related_account_group_memberships`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchRelatedAccountGroupMemberships`` requests and continue to iterate + through the ``related_account_group_memberships`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` + 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[..., recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse], + request: recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, + response: recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, + *, + 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.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse): + 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: + 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[recaptchaenterprise.RelatedAccountGroupMembership]: + for page in self.pages: + yield from page.related_account_group_memberships + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchRelatedAccountGroupMembershipsAsyncPager: + """A pager for iterating through ``search_related_account_group_memberships`` requests. + + This class thinly wraps an initial + :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``related_account_group_memberships`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchRelatedAccountGroupMemberships`` requests and continue to iterate + through the ``related_account_group_memberships`` field on the + corresponding responses. + + All the usual :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` + 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[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]], + request: recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, + response: recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, + *, + 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.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest): + The initial request object. + response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse): + 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: + 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[recaptchaenterprise.RelatedAccountGroupMembership]: + async def async_generator(): + async for page in self.pages: + for response in page.related_account_group_memberships: + 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/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py new file mode 100644 index 0000000..afd885b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- 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 RecaptchaEnterpriseServiceTransport +from .grpc import RecaptchaEnterpriseServiceGrpcTransport +from .grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] +_transport_registry['grpc'] = RecaptchaEnterpriseServiceGrpcTransport +_transport_registry['grpc_asyncio'] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport + +__all__ = ( + 'RecaptchaEnterpriseServiceTransport', + 'RecaptchaEnterpriseServiceGrpcTransport', + 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py new file mode 100644 index 0000000..f8f3c5b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py @@ -0,0 +1,317 @@ +# -*- 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.recaptchaenterprise_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.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class RecaptchaEnterpriseServiceTransport(abc.ABC): + """Abstract transport class for RecaptchaEnterpriseService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'recaptchaenterprise.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_assessment: gapic_v1.method.wrap_method( + self.create_assessment, + default_timeout=600.0, + client_info=client_info, + ), + self.annotate_assessment: gapic_v1.method.wrap_method( + self.annotate_assessment, + default_timeout=600.0, + client_info=client_info, + ), + self.create_key: gapic_v1.method.wrap_method( + self.create_key, + default_timeout=600.0, + client_info=client_info, + ), + self.list_keys: gapic_v1.method.wrap_method( + self.list_keys, + default_timeout=600.0, + client_info=client_info, + ), + self.retrieve_legacy_secret_key: gapic_v1.method.wrap_method( + self.retrieve_legacy_secret_key, + default_timeout=None, + client_info=client_info, + ), + self.get_key: gapic_v1.method.wrap_method( + self.get_key, + default_timeout=600.0, + client_info=client_info, + ), + self.update_key: gapic_v1.method.wrap_method( + self.update_key, + default_timeout=600.0, + client_info=client_info, + ), + self.delete_key: gapic_v1.method.wrap_method( + self.delete_key, + default_timeout=600.0, + client_info=client_info, + ), + self.migrate_key: gapic_v1.method.wrap_method( + self.migrate_key, + default_timeout=None, + client_info=client_info, + ), + self.get_metrics: gapic_v1.method.wrap_method( + self.get_metrics, + default_timeout=None, + client_info=client_info, + ), + self.list_related_account_groups: gapic_v1.method.wrap_method( + self.list_related_account_groups, + default_timeout=None, + client_info=client_info, + ), + self.list_related_account_group_memberships: gapic_v1.method.wrap_method( + self.list_related_account_group_memberships, + default_timeout=None, + client_info=client_info, + ), + self.search_related_account_group_memberships: gapic_v1.method.wrap_method( + self.search_related_account_group_memberships, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + Union[ + recaptchaenterprise.Assessment, + Awaitable[recaptchaenterprise.Assessment] + ]]: + raise NotImplementedError() + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + Union[ + recaptchaenterprise.AnnotateAssessmentResponse, + Awaitable[recaptchaenterprise.AnnotateAssessmentResponse] + ]]: + raise NotImplementedError() + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + Union[ + recaptchaenterprise.ListKeysResponse, + Awaitable[recaptchaenterprise.ListKeysResponse] + ]]: + raise NotImplementedError() + + @property + def retrieve_legacy_secret_key(self) -> Callable[ + [recaptchaenterprise.RetrieveLegacySecretKeyRequest], + Union[ + recaptchaenterprise.RetrieveLegacySecretKeyResponse, + Awaitable[recaptchaenterprise.RetrieveLegacySecretKeyResponse] + ]]: + raise NotImplementedError() + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def migrate_key(self) -> Callable[ + [recaptchaenterprise.MigrateKeyRequest], + Union[ + recaptchaenterprise.Key, + Awaitable[recaptchaenterprise.Key] + ]]: + raise NotImplementedError() + + @property + def get_metrics(self) -> Callable[ + [recaptchaenterprise.GetMetricsRequest], + Union[ + recaptchaenterprise.Metrics, + Awaitable[recaptchaenterprise.Metrics] + ]]: + raise NotImplementedError() + + @property + def list_related_account_groups(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupsRequest], + Union[ + recaptchaenterprise.ListRelatedAccountGroupsResponse, + Awaitable[recaptchaenterprise.ListRelatedAccountGroupsResponse] + ]]: + raise NotImplementedError() + + @property + def list_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], + Union[ + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, + Awaitable[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse] + ]]: + raise NotImplementedError() + + @property + def search_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], + Union[ + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, + Awaitable[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'RecaptchaEnterpriseServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py new file mode 100644 index 0000000..606b67a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py @@ -0,0 +1,592 @@ +# -*- 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.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore +from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO + + +class RecaptchaEnterpriseServiceGrpcTransport(RecaptchaEnterpriseServiceTransport): + """gRPC backend transport for RecaptchaEnterpriseService. + + Service to determine the likelihood an event is legitimate. + + 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 = 'recaptchaenterprise.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 = 'recaptchaenterprise.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_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + recaptchaenterprise.Assessment]: + r"""Return a callable for the create assessment method over gRPC. + + Creates an Assessment of the likelihood an event is + legitimate. + + Returns: + Callable[[~.CreateAssessmentRequest], + ~.Assessment]: + 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_assessment' not in self._stubs: + self._stubs['create_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', + request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.Assessment.deserialize, + ) + return self._stubs['create_assessment'] + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + recaptchaenterprise.AnnotateAssessmentResponse]: + r"""Return a callable for the annotate assessment method over gRPC. + + Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fraudulent. + + Returns: + Callable[[~.AnnotateAssessmentRequest], + ~.AnnotateAssessmentResponse]: + 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 'annotate_assessment' not in self._stubs: + self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', + request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, + ) + return self._stubs['annotate_assessment'] + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the create key method over gRPC. + + Creates a new reCAPTCHA Enterprise key. + + Returns: + Callable[[~.CreateKeyRequest], + ~.Key]: + 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_key' not in self._stubs: + self._stubs['create_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', + request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['create_key'] + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + recaptchaenterprise.ListKeysResponse]: + r"""Return a callable for the list keys method over gRPC. + + Returns the list of all keys that belong to a + project. + + Returns: + Callable[[~.ListKeysRequest], + ~.ListKeysResponse]: + 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_keys' not in self._stubs: + self._stubs['list_keys'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', + request_serializer=recaptchaenterprise.ListKeysRequest.serialize, + response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, + ) + return self._stubs['list_keys'] + + @property + def retrieve_legacy_secret_key(self) -> Callable[ + [recaptchaenterprise.RetrieveLegacySecretKeyRequest], + recaptchaenterprise.RetrieveLegacySecretKeyResponse]: + r"""Return a callable for the retrieve legacy secret key method over gRPC. + + Returns the secret key related to the specified + public key. You must use the legacy secret key only in a + 3rd party integration with legacy reCAPTCHA. + + Returns: + Callable[[~.RetrieveLegacySecretKeyRequest], + ~.RetrieveLegacySecretKeyResponse]: + 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 'retrieve_legacy_secret_key' not in self._stubs: + self._stubs['retrieve_legacy_secret_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RetrieveLegacySecretKey', + request_serializer=recaptchaenterprise.RetrieveLegacySecretKeyRequest.serialize, + response_deserializer=recaptchaenterprise.RetrieveLegacySecretKeyResponse.deserialize, + ) + return self._stubs['retrieve_legacy_secret_key'] + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the get key method over gRPC. + + Returns the specified key. + + Returns: + Callable[[~.GetKeyRequest], + ~.Key]: + 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_key' not in self._stubs: + self._stubs['get_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', + request_serializer=recaptchaenterprise.GetKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['get_key'] + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the update key method over gRPC. + + Updates the specified key. + + Returns: + Callable[[~.UpdateKeyRequest], + ~.Key]: + 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_key' not in self._stubs: + self._stubs['update_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', + request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['update_key'] + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete key method over gRPC. + + Deletes the specified key. + + Returns: + Callable[[~.DeleteKeyRequest], + ~.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_key' not in self._stubs: + self._stubs['delete_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', + request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_key'] + + @property + def migrate_key(self) -> Callable[ + [recaptchaenterprise.MigrateKeyRequest], + recaptchaenterprise.Key]: + r"""Return a callable for the migrate key method over gRPC. + + Migrates an existing key from reCAPTCHA to reCAPTCHA + Enterprise. Once a key is migrated, it can be used from + either product. SiteVerify requests are billed as + CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Site Key, and + your user must have the reCAPTCHA Enterprise Admin IAM + role in the destination project. + + Returns: + Callable[[~.MigrateKeyRequest], + ~.Key]: + 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 'migrate_key' not in self._stubs: + self._stubs['migrate_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/MigrateKey', + request_serializer=recaptchaenterprise.MigrateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['migrate_key'] + + @property + def get_metrics(self) -> Callable[ + [recaptchaenterprise.GetMetricsRequest], + recaptchaenterprise.Metrics]: + r"""Return a callable for the get metrics method over gRPC. + + Get some aggregated metrics for a Key. This data can + be used to build dashboards. + + Returns: + Callable[[~.GetMetricsRequest], + ~.Metrics]: + 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_metrics' not in self._stubs: + self._stubs['get_metrics'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetMetrics', + request_serializer=recaptchaenterprise.GetMetricsRequest.serialize, + response_deserializer=recaptchaenterprise.Metrics.deserialize, + ) + return self._stubs['get_metrics'] + + @property + def list_related_account_groups(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupsRequest], + recaptchaenterprise.ListRelatedAccountGroupsResponse]: + r"""Return a callable for the list related account groups method over gRPC. + + List groups of related accounts. + + Returns: + Callable[[~.ListRelatedAccountGroupsRequest], + ~.ListRelatedAccountGroupsResponse]: + 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_related_account_groups' not in self._stubs: + self._stubs['list_related_account_groups'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroups', + request_serializer=recaptchaenterprise.ListRelatedAccountGroupsRequest.serialize, + response_deserializer=recaptchaenterprise.ListRelatedAccountGroupsResponse.deserialize, + ) + return self._stubs['list_related_account_groups'] + + @property + def list_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: + r"""Return a callable for the list related account group + memberships method over gRPC. + + Get memberships in a group of related accounts. + + Returns: + Callable[[~.ListRelatedAccountGroupMembershipsRequest], + ~.ListRelatedAccountGroupMembershipsResponse]: + 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_related_account_group_memberships' not in self._stubs: + self._stubs['list_related_account_group_memberships'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroupMemberships', + request_serializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest.serialize, + response_deserializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse.deserialize, + ) + return self._stubs['list_related_account_group_memberships'] + + @property + def search_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: + r"""Return a callable for the search related account group + memberships method over gRPC. + + Search group memberships related to a given account. + + Returns: + Callable[[~.SearchRelatedAccountGroupMembershipsRequest], + ~.SearchRelatedAccountGroupMembershipsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_related_account_group_memberships' not in self._stubs: + self._stubs['search_related_account_group_memberships'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/SearchRelatedAccountGroupMemberships', + request_serializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest.serialize, + response_deserializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse.deserialize, + ) + return self._stubs['search_related_account_group_memberships'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'RecaptchaEnterpriseServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..8d041fc --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py @@ -0,0 +1,591 @@ +# -*- 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.recaptchaenterprise_v1.types import recaptchaenterprise +from google.protobuf import empty_pb2 # type: ignore +from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import RecaptchaEnterpriseServiceGrpcTransport + + +class RecaptchaEnterpriseServiceGrpcAsyncIOTransport(RecaptchaEnterpriseServiceTransport): + """gRPC AsyncIO backend transport for RecaptchaEnterpriseService. + + Service to determine the likelihood an event is legitimate. + + 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 = 'recaptchaenterprise.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 = 'recaptchaenterprise.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_assessment(self) -> Callable[ + [recaptchaenterprise.CreateAssessmentRequest], + Awaitable[recaptchaenterprise.Assessment]]: + r"""Return a callable for the create assessment method over gRPC. + + Creates an Assessment of the likelihood an event is + legitimate. + + Returns: + Callable[[~.CreateAssessmentRequest], + Awaitable[~.Assessment]]: + 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_assessment' not in self._stubs: + self._stubs['create_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', + request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.Assessment.deserialize, + ) + return self._stubs['create_assessment'] + + @property + def annotate_assessment(self) -> Callable[ + [recaptchaenterprise.AnnotateAssessmentRequest], + Awaitable[recaptchaenterprise.AnnotateAssessmentResponse]]: + r"""Return a callable for the annotate assessment method over gRPC. + + Annotates a previously created Assessment to provide + additional information on whether the event turned out + to be authentic or fraudulent. + + Returns: + Callable[[~.AnnotateAssessmentRequest], + Awaitable[~.AnnotateAssessmentResponse]]: + 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 'annotate_assessment' not in self._stubs: + self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', + request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, + response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, + ) + return self._stubs['annotate_assessment'] + + @property + def create_key(self) -> Callable[ + [recaptchaenterprise.CreateKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the create key method over gRPC. + + Creates a new reCAPTCHA Enterprise key. + + Returns: + Callable[[~.CreateKeyRequest], + Awaitable[~.Key]]: + 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_key' not in self._stubs: + self._stubs['create_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', + request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['create_key'] + + @property + def list_keys(self) -> Callable[ + [recaptchaenterprise.ListKeysRequest], + Awaitable[recaptchaenterprise.ListKeysResponse]]: + r"""Return a callable for the list keys method over gRPC. + + Returns the list of all keys that belong to a + project. + + Returns: + Callable[[~.ListKeysRequest], + Awaitable[~.ListKeysResponse]]: + 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_keys' not in self._stubs: + self._stubs['list_keys'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', + request_serializer=recaptchaenterprise.ListKeysRequest.serialize, + response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, + ) + return self._stubs['list_keys'] + + @property + def retrieve_legacy_secret_key(self) -> Callable[ + [recaptchaenterprise.RetrieveLegacySecretKeyRequest], + Awaitable[recaptchaenterprise.RetrieveLegacySecretKeyResponse]]: + r"""Return a callable for the retrieve legacy secret key method over gRPC. + + Returns the secret key related to the specified + public key. You must use the legacy secret key only in a + 3rd party integration with legacy reCAPTCHA. + + Returns: + Callable[[~.RetrieveLegacySecretKeyRequest], + Awaitable[~.RetrieveLegacySecretKeyResponse]]: + 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 'retrieve_legacy_secret_key' not in self._stubs: + self._stubs['retrieve_legacy_secret_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RetrieveLegacySecretKey', + request_serializer=recaptchaenterprise.RetrieveLegacySecretKeyRequest.serialize, + response_deserializer=recaptchaenterprise.RetrieveLegacySecretKeyResponse.deserialize, + ) + return self._stubs['retrieve_legacy_secret_key'] + + @property + def get_key(self) -> Callable[ + [recaptchaenterprise.GetKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the get key method over gRPC. + + Returns the specified key. + + Returns: + Callable[[~.GetKeyRequest], + Awaitable[~.Key]]: + 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_key' not in self._stubs: + self._stubs['get_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', + request_serializer=recaptchaenterprise.GetKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['get_key'] + + @property + def update_key(self) -> Callable[ + [recaptchaenterprise.UpdateKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the update key method over gRPC. + + Updates the specified key. + + Returns: + Callable[[~.UpdateKeyRequest], + Awaitable[~.Key]]: + 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_key' not in self._stubs: + self._stubs['update_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', + request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['update_key'] + + @property + def delete_key(self) -> Callable[ + [recaptchaenterprise.DeleteKeyRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete key method over gRPC. + + Deletes the specified key. + + Returns: + Callable[[~.DeleteKeyRequest], + 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_key' not in self._stubs: + self._stubs['delete_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', + request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_key'] + + @property + def migrate_key(self) -> Callable[ + [recaptchaenterprise.MigrateKeyRequest], + Awaitable[recaptchaenterprise.Key]]: + r"""Return a callable for the migrate key method over gRPC. + + Migrates an existing key from reCAPTCHA to reCAPTCHA + Enterprise. Once a key is migrated, it can be used from + either product. SiteVerify requests are billed as + CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Site Key, and + your user must have the reCAPTCHA Enterprise Admin IAM + role in the destination project. + + Returns: + Callable[[~.MigrateKeyRequest], + Awaitable[~.Key]]: + 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 'migrate_key' not in self._stubs: + self._stubs['migrate_key'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/MigrateKey', + request_serializer=recaptchaenterprise.MigrateKeyRequest.serialize, + response_deserializer=recaptchaenterprise.Key.deserialize, + ) + return self._stubs['migrate_key'] + + @property + def get_metrics(self) -> Callable[ + [recaptchaenterprise.GetMetricsRequest], + Awaitable[recaptchaenterprise.Metrics]]: + r"""Return a callable for the get metrics method over gRPC. + + Get some aggregated metrics for a Key. This data can + be used to build dashboards. + + Returns: + Callable[[~.GetMetricsRequest], + Awaitable[~.Metrics]]: + 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_metrics' not in self._stubs: + self._stubs['get_metrics'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetMetrics', + request_serializer=recaptchaenterprise.GetMetricsRequest.serialize, + response_deserializer=recaptchaenterprise.Metrics.deserialize, + ) + return self._stubs['get_metrics'] + + @property + def list_related_account_groups(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupsRequest], + Awaitable[recaptchaenterprise.ListRelatedAccountGroupsResponse]]: + r"""Return a callable for the list related account groups method over gRPC. + + List groups of related accounts. + + Returns: + Callable[[~.ListRelatedAccountGroupsRequest], + Awaitable[~.ListRelatedAccountGroupsResponse]]: + 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_related_account_groups' not in self._stubs: + self._stubs['list_related_account_groups'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroups', + request_serializer=recaptchaenterprise.ListRelatedAccountGroupsRequest.serialize, + response_deserializer=recaptchaenterprise.ListRelatedAccountGroupsResponse.deserialize, + ) + return self._stubs['list_related_account_groups'] + + @property + def list_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], + Awaitable[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]]: + r"""Return a callable for the list related account group + memberships method over gRPC. + + Get memberships in a group of related accounts. + + Returns: + Callable[[~.ListRelatedAccountGroupMembershipsRequest], + Awaitable[~.ListRelatedAccountGroupMembershipsResponse]]: + 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_related_account_group_memberships' not in self._stubs: + self._stubs['list_related_account_group_memberships'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroupMemberships', + request_serializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest.serialize, + response_deserializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse.deserialize, + ) + return self._stubs['list_related_account_group_memberships'] + + @property + def search_related_account_group_memberships(self) -> Callable[ + [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], + Awaitable[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]]: + r"""Return a callable for the search related account group + memberships method over gRPC. + + Search group memberships related to a given account. + + Returns: + Callable[[~.SearchRelatedAccountGroupMembershipsRequest], + Awaitable[~.SearchRelatedAccountGroupMembershipsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'search_related_account_group_memberships' not in self._stubs: + self._stubs['search_related_account_group_memberships'] = self.grpc_channel.unary_unary( + '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/SearchRelatedAccountGroupMemberships', + request_serializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest.serialize, + response_deserializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse.deserialize, + ) + return self._stubs['search_related_account_group_memberships'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py new file mode 100644 index 0000000..3070373 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.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 .recaptchaenterprise import ( + AccountDefenderAssessment, + AccountVerificationInfo, + AndroidKeySettings, + AnnotateAssessmentRequest, + AnnotateAssessmentResponse, + Assessment, + ChallengeMetrics, + CreateAssessmentRequest, + CreateKeyRequest, + DeleteKeyRequest, + EndpointVerificationInfo, + Event, + FraudPreventionAssessment, + GetKeyRequest, + GetMetricsRequest, + IOSKeySettings, + Key, + ListKeysRequest, + ListKeysResponse, + ListRelatedAccountGroupMembershipsRequest, + ListRelatedAccountGroupMembershipsResponse, + ListRelatedAccountGroupsRequest, + ListRelatedAccountGroupsResponse, + Metrics, + MigrateKeyRequest, + PrivatePasswordLeakVerification, + RelatedAccountGroup, + RelatedAccountGroupMembership, + RetrieveLegacySecretKeyRequest, + RetrieveLegacySecretKeyResponse, + RiskAnalysis, + ScoreDistribution, + ScoreMetrics, + SearchRelatedAccountGroupMembershipsRequest, + SearchRelatedAccountGroupMembershipsResponse, + TestingOptions, + TokenProperties, + TransactionData, + TransactionEvent, + UpdateKeyRequest, + WafSettings, + WebKeySettings, +) + +__all__ = ( + 'AccountDefenderAssessment', + 'AccountVerificationInfo', + 'AndroidKeySettings', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'Assessment', + 'ChallengeMetrics', + 'CreateAssessmentRequest', + 'CreateKeyRequest', + 'DeleteKeyRequest', + 'EndpointVerificationInfo', + 'Event', + 'FraudPreventionAssessment', + 'GetKeyRequest', + 'GetMetricsRequest', + 'IOSKeySettings', + 'Key', + 'ListKeysRequest', + 'ListKeysResponse', + 'ListRelatedAccountGroupMembershipsRequest', + 'ListRelatedAccountGroupMembershipsResponse', + 'ListRelatedAccountGroupsRequest', + 'ListRelatedAccountGroupsResponse', + 'Metrics', + 'MigrateKeyRequest', + 'PrivatePasswordLeakVerification', + 'RelatedAccountGroup', + 'RelatedAccountGroupMembership', + 'RetrieveLegacySecretKeyRequest', + 'RetrieveLegacySecretKeyResponse', + 'RiskAnalysis', + 'ScoreDistribution', + 'ScoreMetrics', + 'SearchRelatedAccountGroupMembershipsRequest', + 'SearchRelatedAccountGroupMembershipsResponse', + 'TestingOptions', + 'TokenProperties', + 'TransactionData', + 'TransactionEvent', + 'UpdateKeyRequest', + 'WafSettings', + 'WebKeySettings', +) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py new file mode 100644 index 0000000..270d5ac --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py @@ -0,0 +1,2232 @@ +# -*- 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.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.recaptchaenterprise.v1', + manifest={ + 'CreateAssessmentRequest', + 'TransactionEvent', + 'AnnotateAssessmentRequest', + 'AnnotateAssessmentResponse', + 'EndpointVerificationInfo', + 'AccountVerificationInfo', + 'PrivatePasswordLeakVerification', + 'Assessment', + 'Event', + 'TransactionData', + 'RiskAnalysis', + 'TokenProperties', + 'FraudPreventionAssessment', + 'AccountDefenderAssessment', + 'CreateKeyRequest', + 'ListKeysRequest', + 'ListKeysResponse', + 'RetrieveLegacySecretKeyRequest', + 'GetKeyRequest', + 'UpdateKeyRequest', + 'DeleteKeyRequest', + 'MigrateKeyRequest', + 'GetMetricsRequest', + 'Metrics', + 'RetrieveLegacySecretKeyResponse', + 'Key', + 'TestingOptions', + 'WebKeySettings', + 'AndroidKeySettings', + 'IOSKeySettings', + 'ScoreDistribution', + 'ScoreMetrics', + 'ChallengeMetrics', + 'ListRelatedAccountGroupMembershipsRequest', + 'ListRelatedAccountGroupMembershipsResponse', + 'ListRelatedAccountGroupsRequest', + 'ListRelatedAccountGroupsResponse', + 'SearchRelatedAccountGroupMembershipsRequest', + 'SearchRelatedAccountGroupMembershipsResponse', + 'RelatedAccountGroupMembership', + 'RelatedAccountGroup', + 'WafSettings', + }, +) + + +class CreateAssessmentRequest(proto.Message): + r"""The create assessment request message. + + Attributes: + parent (str): + Required. The name of the project in which + the assessment will be created, in the format + "projects/{project}". + assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): + Required. The assessment details. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + assessment: 'Assessment' = proto.Field( + proto.MESSAGE, + number=2, + message='Assessment', + ) + + +class TransactionEvent(proto.Message): + r"""Describes an event in the lifecycle of a payment transaction. + + Attributes: + event_type (google.cloud.recaptchaenterprise_v1.types.TransactionEvent.TransactionEventType): + Optional. The type of this transaction event. + reason (str): + Optional. The reason or standardized code + that corresponds with this transaction event, if + one exists. For example, a CHARGEBACK event with + code 6005. + value (float): + Optional. The value that corresponds with + this transaction event, if one exists. For + example, a refund event where $5.00 was + refunded. Currency is obtained from the original + transaction data. + event_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. Timestamp when this transaction + event occurred; otherwise assumed to be the time + of the API call. + """ + class TransactionEventType(proto.Enum): + r"""Enum that represents an event in the payment transaction + lifecycle. + + Values: + TRANSACTION_EVENT_TYPE_UNSPECIFIED (0): + Default, unspecified event type. + MERCHANT_APPROVE (1): + Indicates that the transaction is approved by the merchant. + The accompanying reasons can include terms such as + 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + MERCHANT_DENY (2): + Indicates that the transaction is denied and concluded due + to risks detected by the merchant. The accompanying reasons + can include terms such as 'INHOUSE', 'ACCERTIFY', + 'CYBERSOURCE', or 'MANUAL_REVIEW'. + MANUAL_REVIEW (3): + Indicates that the transaction is being + evaluated by a human, due to suspicion or risk. + AUTHORIZATION (4): + Indicates that the authorization attempt with + the card issuer succeeded. + AUTHORIZATION_DECLINE (5): + Indicates that the authorization attempt with + the card issuer failed. The accompanying reasons + can include Visa's '54' indicating that the card + is expired, or '82' indicating that the CVV is + incorrect. + PAYMENT_CAPTURE (6): + Indicates that the transaction is completed + because the funds were settled. + PAYMENT_CAPTURE_DECLINE (7): + Indicates that the transaction could not be + completed because the funds were not settled. + CANCEL (8): + Indicates that the transaction has been canceled. Specify + the reason for the cancellation. For example, + 'INSUFFICIENT_INVENTORY'. + CHARGEBACK_INQUIRY (9): + Indicates that the merchant has received a + chargeback inquiry due to fraud for the + transaction, requesting additional information + before a fraud chargeback is officially issued + and a formal chargeback notification is sent. + CHARGEBACK_ALERT (10): + Indicates that the merchant has received a + chargeback alert due to fraud for the + transaction. The process of resolving the + dispute without involving the payment network is + started. + FRAUD_NOTIFICATION (11): + Indicates that a fraud notification is issued for the + transaction, sent by the payment instrument's issuing bank + because the transaction appears to be fraudulent. We + recommend including TC40 or SAFE data in the ``reason`` + field for this event type. For partial chargebacks, we + recommend that you include an amount in the ``value`` field. + CHARGEBACK (12): + Indicates that the merchant is informed by the payment + network that the transaction has entered the chargeback + process due to fraud. Reason code examples include + Discover's '6005' and '6041'. For partial chargebacks, we + recommend that you include an amount in the ``value`` field. + CHARGEBACK_REPRESENTMENT (13): + Indicates that the transaction has entered the chargeback + process due to fraud, and that the merchant has chosen to + enter representment. Reason examples include Discover's + '6005' and '6041'. For partial chargebacks, we recommend + that you include an amount in the ``value`` field. + CHARGEBACK_REVERSE (14): + Indicates that the transaction has had a fraud chargeback + which was illegitimate and was reversed as a result. For + partial chargebacks, we recommend that you include an amount + in the ``value`` field. + REFUND_REQUEST (15): + Indicates that the merchant has received a refund for a + completed transaction. For partial refunds, we recommend + that you include an amount in the ``value`` field. Reason + example: 'TAX_EXEMPT' (partial refund of exempt tax) + REFUND_DECLINE (16): + Indicates that the merchant has received a refund request + for this transaction, but that they have declined it. For + partial refunds, we recommend that you include an amount in + the ``value`` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + REFUND (17): + Indicates that the completed transaction was refunded by the + merchant. For partial refunds, we recommend that you include + an amount in the ``value`` field. Reason example: + 'TAX_EXEMPT' (partial refund of exempt tax) + REFUND_REVERSE (18): + Indicates that the completed transaction was refunded by the + merchant, and that this refund was reversed. For partial + refunds, we recommend that you include an amount in the + ``value`` field. + """ + TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0 + MERCHANT_APPROVE = 1 + MERCHANT_DENY = 2 + MANUAL_REVIEW = 3 + AUTHORIZATION = 4 + AUTHORIZATION_DECLINE = 5 + PAYMENT_CAPTURE = 6 + PAYMENT_CAPTURE_DECLINE = 7 + CANCEL = 8 + CHARGEBACK_INQUIRY = 9 + CHARGEBACK_ALERT = 10 + FRAUD_NOTIFICATION = 11 + CHARGEBACK = 12 + CHARGEBACK_REPRESENTMENT = 13 + CHARGEBACK_REVERSE = 14 + REFUND_REQUEST = 15 + REFUND_DECLINE = 16 + REFUND = 17 + REFUND_REVERSE = 18 + + event_type: TransactionEventType = proto.Field( + proto.ENUM, + number=1, + enum=TransactionEventType, + ) + reason: str = proto.Field( + proto.STRING, + number=2, + ) + value: float = proto.Field( + proto.DOUBLE, + number=3, + ) + event_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + + +class AnnotateAssessmentRequest(proto.Message): + r"""The request message to annotate an Assessment. + + Attributes: + name (str): + Required. The resource name of the + Assessment, in the format + "projects/{project}/assessments/{assessment}". + annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): + Optional. The annotation that will be + assigned to the Event. This field can be left + empty to provide reasons that apply to an event + without concluding whether the event is + legitimate or fraudulent. + reasons (MutableSequence[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Reason]): + Optional. Optional reasons for the annotation + that will be assigned to the Event. + hashed_account_id (bytes): + Optional. Unique stable hashed user identifier to apply to + the assessment. This is an alternative to setting the + hashed_account_id in CreateAssessment, for example when the + account identifier is not yet known in the initial request. + It is recommended that the identifier is hashed using + hmac-sha256 with stable secret. + transaction_event (google.cloud.recaptchaenterprise_v1.types.TransactionEvent): + Optional. If the assessment is part of a + payment transaction, provide details on payment + lifecycle events that occur in the transaction. + """ + class Annotation(proto.Enum): + r"""Enum that represents the types of annotations. + + Values: + ANNOTATION_UNSPECIFIED (0): + Default unspecified type. + LEGITIMATE (1): + Provides information that the event turned + out to be legitimate. + FRAUDULENT (2): + Provides information that the event turned + out to be fraudulent. + PASSWORD_CORRECT (3): + Provides information that the event was related to a login + event in which the user typed the correct password. + Deprecated, prefer indicating CORRECT_PASSWORD through the + reasons field instead. + PASSWORD_INCORRECT (4): + Provides information that the event was related to a login + event in which the user typed the incorrect password. + Deprecated, prefer indicating INCORRECT_PASSWORD through the + reasons field instead. + """ + ANNOTATION_UNSPECIFIED = 0 + LEGITIMATE = 1 + FRAUDULENT = 2 + PASSWORD_CORRECT = 3 + PASSWORD_INCORRECT = 4 + + class Reason(proto.Enum): + r"""Enum that represents potential reasons for annotating an + assessment. + + Values: + REASON_UNSPECIFIED (0): + Default unspecified reason. + CHARGEBACK (1): + Indicates that the transaction had a chargeback issued with + no other details. When possible, specify the type by using + CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. + CHARGEBACK_FRAUD (8): + Indicates that the transaction had a + chargeback issued related to an alleged + unauthorized transaction from the cardholder's + perspective (for example, the card number was + stolen). + CHARGEBACK_DISPUTE (9): + Indicates that the transaction had a + chargeback issued related to the cardholder + having provided their card details but allegedly + not being satisfied with the purchase (for + example, misrepresentation, attempted + cancellation). + REFUND (10): + Indicates that the completed payment + transaction was refunded by the seller. + REFUND_FRAUD (11): + Indicates that the completed payment + transaction was determined to be fraudulent by + the seller, and was cancelled and refunded as a + result. + TRANSACTION_ACCEPTED (12): + Indicates that the payment transaction was + accepted, and the user was charged. + TRANSACTION_DECLINED (13): + Indicates that the payment transaction was + declined, for example due to invalid card + details. + PAYMENT_HEURISTICS (2): + Indicates the transaction associated with the + assessment is suspected of being fraudulent + based on the payment method, billing details, + shipping address or other transaction + information. + INITIATED_TWO_FACTOR (7): + Indicates that the user was served a 2FA challenge. An old + assessment with ``ENUM_VALUES.INITIATED_TWO_FACTOR`` reason + that has not been overwritten with ``PASSED_TWO_FACTOR`` is + treated as an abandoned 2FA flow. This is equivalent to + ``FAILED_TWO_FACTOR``. + PASSED_TWO_FACTOR (3): + Indicates that the user passed a 2FA + challenge. + FAILED_TWO_FACTOR (4): + Indicates that the user failed a 2FA + challenge. + CORRECT_PASSWORD (5): + Indicates the user provided the correct + password. + INCORRECT_PASSWORD (6): + Indicates the user provided an incorrect + password. + SOCIAL_SPAM (14): + Indicates that the user sent unwanted and + abusive messages to other users of the platform, + such as spam, scams, phishing, or social + engineering. + """ + REASON_UNSPECIFIED = 0 + CHARGEBACK = 1 + CHARGEBACK_FRAUD = 8 + CHARGEBACK_DISPUTE = 9 + REFUND = 10 + REFUND_FRAUD = 11 + TRANSACTION_ACCEPTED = 12 + TRANSACTION_DECLINED = 13 + PAYMENT_HEURISTICS = 2 + INITIATED_TWO_FACTOR = 7 + PASSED_TWO_FACTOR = 3 + FAILED_TWO_FACTOR = 4 + CORRECT_PASSWORD = 5 + INCORRECT_PASSWORD = 6 + SOCIAL_SPAM = 14 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + annotation: Annotation = proto.Field( + proto.ENUM, + number=2, + enum=Annotation, + ) + reasons: MutableSequence[Reason] = proto.RepeatedField( + proto.ENUM, + number=3, + enum=Reason, + ) + hashed_account_id: bytes = proto.Field( + proto.BYTES, + number=4, + ) + transaction_event: 'TransactionEvent' = proto.Field( + proto.MESSAGE, + number=5, + message='TransactionEvent', + ) + + +class AnnotateAssessmentResponse(proto.Message): + r"""Empty response for AnnotateAssessment. + """ + + +class EndpointVerificationInfo(proto.Message): + r"""Information about a verification endpoint that can be used + for 2FA. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + email_address (str): + Email address for which to trigger a + verification request. + + This field is a member of `oneof`_ ``endpoint``. + phone_number (str): + Phone number for which to trigger a + verification request. Should be given in E.164 + format. + + This field is a member of `oneof`_ ``endpoint``. + request_token (str): + Output only. Token to provide to the client + to trigger endpoint verification. It must be + used within 15 minutes. + last_verification_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Timestamp of the last successful + verification for the endpoint, if any. + """ + + email_address: str = proto.Field( + proto.STRING, + number=1, + oneof='endpoint', + ) + phone_number: str = proto.Field( + proto.STRING, + number=2, + oneof='endpoint', + ) + request_token: str = proto.Field( + proto.STRING, + number=3, + ) + last_verification_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + + +class AccountVerificationInfo(proto.Message): + r"""Information about account verification, used for identity + verification. + + Attributes: + endpoints (MutableSequence[google.cloud.recaptchaenterprise_v1.types.EndpointVerificationInfo]): + Endpoints that can be used for identity + verification. + language_code (str): + Language code preference for the verification + message, set as a IETF BCP 47 language code. + latest_verification_result (google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo.Result): + Output only. Result of the latest account + verification challenge. + username (str): + Username of the account that is being + verified. Deprecated. Customers should now + provide the hashed account ID field in Event. + """ + class Result(proto.Enum): + r"""Result of the account verification as contained in the + verdict token issued at the end of the verification flow. + + Values: + RESULT_UNSPECIFIED (0): + No information about the latest account + verification. + SUCCESS_USER_VERIFIED (1): + The user was successfully verified. This + means the account verification challenge was + successfully completed. + ERROR_USER_NOT_VERIFIED (2): + The user failed the verification challenge. + ERROR_SITE_ONBOARDING_INCOMPLETE (3): + The site is not properly onboarded to use the + account verification feature. + ERROR_RECIPIENT_NOT_ALLOWED (4): + The recipient is not allowed for account + verification. This can occur during integration + but should not occur in production. + ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED (5): + The recipient has already been sent too many + verification codes in a short amount of time. + ERROR_CRITICAL_INTERNAL (6): + The verification flow could not be completed + due to a critical internal error. + ERROR_CUSTOMER_QUOTA_EXHAUSTED (7): + The client has exceeded their two factor + request quota for this period of time. + ERROR_VERIFICATION_BYPASSED (8): + The request cannot be processed at the time + because of an incident. This bypass can be + restricted to a problematic destination email + domain, a customer, or could affect the entire + service. + ERROR_VERDICT_MISMATCH (9): + The request parameters do not match with the + token provided and cannot be processed. + """ + RESULT_UNSPECIFIED = 0 + SUCCESS_USER_VERIFIED = 1 + ERROR_USER_NOT_VERIFIED = 2 + ERROR_SITE_ONBOARDING_INCOMPLETE = 3 + ERROR_RECIPIENT_NOT_ALLOWED = 4 + ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5 + ERROR_CRITICAL_INTERNAL = 6 + ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7 + ERROR_VERIFICATION_BYPASSED = 8 + ERROR_VERDICT_MISMATCH = 9 + + endpoints: MutableSequence['EndpointVerificationInfo'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='EndpointVerificationInfo', + ) + language_code: str = proto.Field( + proto.STRING, + number=3, + ) + latest_verification_result: Result = proto.Field( + proto.ENUM, + number=7, + enum=Result, + ) + username: str = proto.Field( + proto.STRING, + number=2, + ) + + +class PrivatePasswordLeakVerification(proto.Message): + r"""Private password leak verification info. + + Attributes: + lookup_hash_prefix (bytes): + Optional. Exactly 26-bit prefix of the + SHA-256 hash of the canonicalized username. It + is used to look up password leaks associated + with that hash prefix. + encrypted_user_credentials_hash (bytes): + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and + returned through ``reencrypted_user_credentials_hash``. + encrypted_leak_match_prefixes (MutableSequence[bytes]): + Output only. List of prefixes of the encrypted potential + password leaks that matched the given parameters. They must + be compared with the client-side decryption prefix of + ``reencrypted_user_credentials_hash`` + reencrypted_user_credentials_hash (bytes): + Output only. Corresponds to the re-encryption of the + ``encrypted_user_credentials_hash`` field. It is used to + match potential password leaks within + ``encrypted_leak_match_prefixes``. + """ + + lookup_hash_prefix: bytes = proto.Field( + proto.BYTES, + number=1, + ) + encrypted_user_credentials_hash: bytes = proto.Field( + proto.BYTES, + number=2, + ) + encrypted_leak_match_prefixes: MutableSequence[bytes] = proto.RepeatedField( + proto.BYTES, + number=3, + ) + reencrypted_user_credentials_hash: bytes = proto.Field( + proto.BYTES, + number=4, + ) + + +class Assessment(proto.Message): + r"""A reCAPTCHA Enterprise assessment resource. + + Attributes: + name (str): + Output only. The resource name for the + Assessment in the format + "projects/{project}/assessments/{assessment}". + event (google.cloud.recaptchaenterprise_v1.types.Event): + The event being assessed. + risk_analysis (google.cloud.recaptchaenterprise_v1.types.RiskAnalysis): + Output only. The risk analysis result for the + event being assessed. + token_properties (google.cloud.recaptchaenterprise_v1.types.TokenProperties): + Output only. Properties of the provided event + token. + account_verification (google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo): + Account verification information for identity + verification. The assessment event must include + a token and site key to use this feature. + account_defender_assessment (google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment): + Assessment returned by account defender when a + hashed_account_id is provided. + private_password_leak_verification (google.cloud.recaptchaenterprise_v1.types.PrivatePasswordLeakVerification): + The private password leak verification field + contains the parameters that are used to to + check for leaks privately without sharing user + credentials. + fraud_prevention_assessment (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment): + Assessment returned by Fraud Prevention when + TransactionData is provided. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + event: 'Event' = proto.Field( + proto.MESSAGE, + number=2, + message='Event', + ) + risk_analysis: 'RiskAnalysis' = proto.Field( + proto.MESSAGE, + number=3, + message='RiskAnalysis', + ) + token_properties: 'TokenProperties' = proto.Field( + proto.MESSAGE, + number=4, + message='TokenProperties', + ) + account_verification: 'AccountVerificationInfo' = proto.Field( + proto.MESSAGE, + number=5, + message='AccountVerificationInfo', + ) + account_defender_assessment: 'AccountDefenderAssessment' = proto.Field( + proto.MESSAGE, + number=6, + message='AccountDefenderAssessment', + ) + private_password_leak_verification: 'PrivatePasswordLeakVerification' = proto.Field( + proto.MESSAGE, + number=8, + message='PrivatePasswordLeakVerification', + ) + fraud_prevention_assessment: 'FraudPreventionAssessment' = proto.Field( + proto.MESSAGE, + number=11, + message='FraudPreventionAssessment', + ) + + +class Event(proto.Message): + r"""The event being assessed. + + Attributes: + token (str): + Optional. The user response token provided by + the reCAPTCHA Enterprise client-side integration + on your site. + site_key (str): + Optional. The site key that was used to + invoke reCAPTCHA Enterprise on your site and + generate the token. + user_agent (str): + Optional. The user agent present in the + request from the user's device related to this + event. + user_ip_address (str): + Optional. The IP address in the request from + the user's device related to this event. + expected_action (str): + Optional. The expected action for this type + of event. This should be the same action + provided at token generation time on client-side + platforms already integrated with recaptcha + enterprise. + hashed_account_id (bytes): + Optional. Unique stable hashed user + identifier for the request. The identifier must + be hashed using hmac-sha256 with stable secret. + transaction_data (google.cloud.recaptchaenterprise_v1.types.TransactionData): + Optional. Data describing a payment + transaction to be assessed. Sending this data + enables reCAPTCHA Enterprise Fraud Prevention + and the FraudPreventionAssessment component in + the response. + """ + + token: str = proto.Field( + proto.STRING, + number=1, + ) + site_key: str = proto.Field( + proto.STRING, + number=2, + ) + user_agent: str = proto.Field( + proto.STRING, + number=3, + ) + user_ip_address: str = proto.Field( + proto.STRING, + number=4, + ) + expected_action: str = proto.Field( + proto.STRING, + number=5, + ) + hashed_account_id: bytes = proto.Field( + proto.BYTES, + number=6, + ) + transaction_data: 'TransactionData' = proto.Field( + proto.MESSAGE, + number=13, + message='TransactionData', + ) + + +class TransactionData(proto.Message): + r"""Transaction data associated with a payment protected by + reCAPTCHA Enterprise. All fields are optional. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + transaction_id (str): + Unique identifier for the transaction. This + custom identifier can be used to reference this + transaction in the future, for example, labeling + a refund or chargeback event. Two attempts at + the same transaction should use the same + transaction id. + + This field is a member of `oneof`_ ``_transaction_id``. + payment_method (str): + The payment method for the transaction. The allowed values + are: + + - credit-card + - debit-card + - gift-card + - processor-{name} (If a third-party is used, for example, + processor-paypal) + - custom-{name} (If an alternative method is used, for + example, custom-crypto) + card_bin (str): + The Bank Identification Number - generally + the first 6 or 8 digits of the card. + card_last_four (str): + The last four digits of the card. + currency_code (str): + The currency code in ISO-4217 format. + value (float): + The decimal value of the transaction in the + specified currency. + shipping_value (float): + The value of shipping in the specified + currency. 0 for free or no shipping. + shipping_address (google.cloud.recaptchaenterprise_v1.types.TransactionData.Address): + Destination address if this transaction + involves shipping a physical item. + billing_address (google.cloud.recaptchaenterprise_v1.types.TransactionData.Address): + Address associated with the payment method + when applicable. + user (google.cloud.recaptchaenterprise_v1.types.TransactionData.User): + Information about the user paying/initiating + the transaction. + merchants (MutableSequence[google.cloud.recaptchaenterprise_v1.types.TransactionData.User]): + Information about the user or users + fulfilling the transaction. + items (MutableSequence[google.cloud.recaptchaenterprise_v1.types.TransactionData.Item]): + Items purchased in this transaction. + gateway_info (google.cloud.recaptchaenterprise_v1.types.TransactionData.GatewayInfo): + Information about the payment gateway's + response to the transaction. + """ + + class Address(proto.Message): + r"""Structured address format for billing and shipping addresses. + + Attributes: + recipient (str): + The recipient name, potentially including + information such as "care of". + address (MutableSequence[str]): + The first lines of the address. The first + line generally contains the street name and + number, and further lines may include + information such as an apartment number. + locality (str): + The town/city of the address. + administrative_area (str): + The state, province, or otherwise + administrative area of the address. + region_code (str): + The CLDR country/region of the address. + postal_code (str): + The postal or ZIP code of the address. + """ + + recipient: str = proto.Field( + proto.STRING, + number=1, + ) + address: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + locality: str = proto.Field( + proto.STRING, + number=3, + ) + administrative_area: str = proto.Field( + proto.STRING, + number=4, + ) + region_code: str = proto.Field( + proto.STRING, + number=5, + ) + postal_code: str = proto.Field( + proto.STRING, + number=6, + ) + + class User(proto.Message): + r"""Details about a user's account involved in the transaction. + + Attributes: + account_id (str): + Unique account identifier for this user. If using account + defender, this should match the hashed_account_id field. + Otherwise, a unique and persistent identifier for this + account. + creation_ms (int): + The epoch milliseconds of the user's account + creation. + email (str): + The email address of the user. + email_verified (bool): + Whether the email has been verified to be + accessible by the user (OTP or similar). + phone_number (str): + The phone number of the user, with country + code. + phone_verified (bool): + Whether the phone number has been verified to + be accessible by the user (OTP or similar). + """ + + account_id: str = proto.Field( + proto.STRING, + number=6, + ) + creation_ms: int = proto.Field( + proto.INT64, + number=1, + ) + email: str = proto.Field( + proto.STRING, + number=2, + ) + email_verified: bool = proto.Field( + proto.BOOL, + number=3, + ) + phone_number: str = proto.Field( + proto.STRING, + number=4, + ) + phone_verified: bool = proto.Field( + proto.BOOL, + number=5, + ) + + class Item(proto.Message): + r"""Line items being purchased in this transaction. + + Attributes: + name (str): + The full name of the item. + value (float): + The value per item that the user is paying, + in the transaction currency, after discounts. + quantity (int): + The quantity of this item that is being + purchased. + merchant_account_id (str): + When a merchant is specified, its corresponding account_id. + Necessary to populate marketplace-style transactions. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + value: float = proto.Field( + proto.DOUBLE, + number=2, + ) + quantity: int = proto.Field( + proto.INT64, + number=3, + ) + merchant_account_id: str = proto.Field( + proto.STRING, + number=4, + ) + + class GatewayInfo(proto.Message): + r"""Details about the transaction from the gateway. + + Attributes: + name (str): + Name of the gateway service (for example, + stripe, square, paypal). + gateway_response_code (str): + Gateway response code describing the state of + the transaction. + avs_response_code (str): + AVS response code from the gateway + (available only when reCAPTCHA Enterprise is + called after authorization). + cvv_response_code (str): + CVV response code from the gateway + (available only when reCAPTCHA Enterprise is + called after authorization). + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + gateway_response_code: str = proto.Field( + proto.STRING, + number=2, + ) + avs_response_code: str = proto.Field( + proto.STRING, + number=3, + ) + cvv_response_code: str = proto.Field( + proto.STRING, + number=4, + ) + + transaction_id: str = proto.Field( + proto.STRING, + number=11, + optional=True, + ) + payment_method: str = proto.Field( + proto.STRING, + number=1, + ) + card_bin: str = proto.Field( + proto.STRING, + number=2, + ) + card_last_four: str = proto.Field( + proto.STRING, + number=3, + ) + currency_code: str = proto.Field( + proto.STRING, + number=4, + ) + value: float = proto.Field( + proto.DOUBLE, + number=5, + ) + shipping_value: float = proto.Field( + proto.DOUBLE, + number=12, + ) + shipping_address: Address = proto.Field( + proto.MESSAGE, + number=6, + message=Address, + ) + billing_address: Address = proto.Field( + proto.MESSAGE, + number=7, + message=Address, + ) + user: User = proto.Field( + proto.MESSAGE, + number=8, + message=User, + ) + merchants: MutableSequence[User] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=User, + ) + items: MutableSequence[Item] = proto.RepeatedField( + proto.MESSAGE, + number=14, + message=Item, + ) + gateway_info: GatewayInfo = proto.Field( + proto.MESSAGE, + number=10, + message=GatewayInfo, + ) + + +class RiskAnalysis(proto.Message): + r"""Risk analysis result for an event. + + Attributes: + score (float): + Legitimate event score from 0.0 to 1.0. + (1.0 means very likely legitimate traffic while + 0.0 means very likely non-legitimate traffic). + reasons (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RiskAnalysis.ClassificationReason]): + Reasons contributing to the risk analysis + verdict. + """ + class ClassificationReason(proto.Enum): + r"""Reasons contributing to the risk analysis verdict. + + Values: + CLASSIFICATION_REASON_UNSPECIFIED (0): + Default unspecified type. + AUTOMATION (1): + Interactions matched the behavior of an + automated agent. + UNEXPECTED_ENVIRONMENT (2): + The event originated from an illegitimate + environment. + TOO_MUCH_TRAFFIC (3): + Traffic volume from the event source is + higher than normal. + UNEXPECTED_USAGE_PATTERNS (4): + Interactions with the site were significantly + different than expected patterns. + LOW_CONFIDENCE_SCORE (5): + Too little traffic has been received from + this site thus far to generate quality risk + analysis. + SUSPECTED_CARDING (6): + The request matches behavioral + characteristics of a carding attack. + SUSPECTED_CHARGEBACK (7): + The request matches behavioral + characteristics of chargebacks for fraud. + """ + CLASSIFICATION_REASON_UNSPECIFIED = 0 + AUTOMATION = 1 + UNEXPECTED_ENVIRONMENT = 2 + TOO_MUCH_TRAFFIC = 3 + UNEXPECTED_USAGE_PATTERNS = 4 + LOW_CONFIDENCE_SCORE = 5 + SUSPECTED_CARDING = 6 + SUSPECTED_CHARGEBACK = 7 + + score: float = proto.Field( + proto.FLOAT, + number=1, + ) + reasons: MutableSequence[ClassificationReason] = proto.RepeatedField( + proto.ENUM, + number=2, + enum=ClassificationReason, + ) + + +class TokenProperties(proto.Message): + r"""Properties of the provided event token. + + Attributes: + valid (bool): + Whether the provided user response token is valid. When + valid = false, the reason could be specified in + invalid_reason or it could also be due to a user failing to + solve a challenge or a sitekey mismatch (i.e the sitekey + used to generate the token was different than the one + specified in the assessment). + invalid_reason (google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason): + Reason associated with the response when + valid = false. + create_time (google.protobuf.timestamp_pb2.Timestamp): + The timestamp corresponding to the generation + of the token. + hostname (str): + The hostname of the page on which the token + was generated (Web keys only). + android_package_name (str): + The name of the Android package with which + the token was generated (Android keys only). + ios_bundle_id (str): + The ID of the iOS bundle with which the token + was generated (iOS keys only). + action (str): + Action name provided at token generation. + """ + class InvalidReason(proto.Enum): + r"""Enum that represents the types of invalid token reasons. + + Values: + INVALID_REASON_UNSPECIFIED (0): + Default unspecified type. + UNKNOWN_INVALID_REASON (1): + If the failure reason was not accounted for. + MALFORMED (2): + The provided user verification token was + malformed. + EXPIRED (3): + The user verification token had expired. + DUPE (4): + The user verification had already been seen. + MISSING (5): + The user verification token was not present. + BROWSER_ERROR (6): + A retriable error (such as network failure) + occurred on the browser. Could easily be + simulated by an attacker. + """ + INVALID_REASON_UNSPECIFIED = 0 + UNKNOWN_INVALID_REASON = 1 + MALFORMED = 2 + EXPIRED = 3 + DUPE = 4 + MISSING = 5 + BROWSER_ERROR = 6 + + valid: bool = proto.Field( + proto.BOOL, + number=1, + ) + invalid_reason: InvalidReason = proto.Field( + proto.ENUM, + number=2, + enum=InvalidReason, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + hostname: str = proto.Field( + proto.STRING, + number=4, + ) + android_package_name: str = proto.Field( + proto.STRING, + number=8, + ) + ios_bundle_id: str = proto.Field( + proto.STRING, + number=9, + ) + action: str = proto.Field( + proto.STRING, + number=5, + ) + + +class FraudPreventionAssessment(proto.Message): + r"""Assessment for Fraud Prevention. + + Attributes: + transaction_risk (float): + Probability (0-1) of this transaction being + fraudulent. Summarizes the combined risk of + attack vectors below. + stolen_instrument_verdict (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment.StolenInstrumentVerdict): + Assessment of this transaction for risk of a + stolen instrument. + card_testing_verdict (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment.CardTestingVerdict): + Assessment of this transaction for risk of + being part of a card testing attack. + """ + + class StolenInstrumentVerdict(proto.Message): + r"""Information about stolen instrument fraud, where the user is + not the legitimate owner of the instrument being used for the + purchase. + + Attributes: + risk (float): + Probability (0-1) of this transaction being + executed with a stolen instrument. + """ + + risk: float = proto.Field( + proto.FLOAT, + number=1, + ) + + class CardTestingVerdict(proto.Message): + r"""Information about card testing fraud, where an adversary is + testing fraudulently obtained cards or brute forcing their + details. + + Attributes: + risk (float): + Probability (0-1) of this transaction attempt + being part of a card testing attack. + """ + + risk: float = proto.Field( + proto.FLOAT, + number=1, + ) + + transaction_risk: float = proto.Field( + proto.FLOAT, + number=1, + ) + stolen_instrument_verdict: StolenInstrumentVerdict = proto.Field( + proto.MESSAGE, + number=2, + message=StolenInstrumentVerdict, + ) + card_testing_verdict: CardTestingVerdict = proto.Field( + proto.MESSAGE, + number=3, + message=CardTestingVerdict, + ) + + +class AccountDefenderAssessment(proto.Message): + r"""Account defender risk assessment. + + Attributes: + labels (MutableSequence[google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment.AccountDefenderLabel]): + Labels for this request. + """ + class AccountDefenderLabel(proto.Enum): + r"""Labels returned by account defender for this request. + + Values: + ACCOUNT_DEFENDER_LABEL_UNSPECIFIED (0): + Default unspecified type. + PROFILE_MATCH (1): + The request matches a known good profile for + the user. + SUSPICIOUS_LOGIN_ACTIVITY (2): + The request is potentially a suspicious login + event and must be further verified either + through multi-factor authentication or another + system. + SUSPICIOUS_ACCOUNT_CREATION (3): + The request matched a profile that previously + had suspicious account creation behavior. This + can mean that this is a fake account. + RELATED_ACCOUNTS_NUMBER_HIGH (4): + The account in the request has a high number + of related accounts. It does not necessarily + imply that the account is bad but can require + further investigation. + """ + ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0 + PROFILE_MATCH = 1 + SUSPICIOUS_LOGIN_ACTIVITY = 2 + SUSPICIOUS_ACCOUNT_CREATION = 3 + RELATED_ACCOUNTS_NUMBER_HIGH = 4 + + labels: MutableSequence[AccountDefenderLabel] = proto.RepeatedField( + proto.ENUM, + number=1, + enum=AccountDefenderLabel, + ) + + +class CreateKeyRequest(proto.Message): + r"""The create key request message. + + Attributes: + parent (str): + Required. The name of the project in which + the key will be created, in the format + "projects/{project}". + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. Information to create a reCAPTCHA + Enterprise key. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + key: 'Key' = proto.Field( + proto.MESSAGE, + number=2, + message='Key', + ) + + +class ListKeysRequest(proto.Message): + r"""The list keys request message. + + Attributes: + parent (str): + Required. The name of the project that + contains the keys that will be listed, in the + format "projects/{project}". + page_size (int): + Optional. The maximum number of keys to + return. Default is 10. Max limit is 1000. + page_token (str): + Optional. The next_page_token value returned from a + previous. ListKeysRequest, if any. + """ + + 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 ListKeysResponse(proto.Message): + r"""Response to request to list keys in a project. + + Attributes: + keys (MutableSequence[google.cloud.recaptchaenterprise_v1.types.Key]): + Key details. + next_page_token (str): + Token to retrieve the next page of results. + It is set to empty if no keys remain in results. + """ + + @property + def raw_page(self): + return self + + keys: MutableSequence['Key'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Key', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RetrieveLegacySecretKeyRequest(proto.Message): + r"""The retrieve legacy secret key request message. + + Attributes: + key (str): + Required. The public key name linked to the + requested secret key in the format + "projects/{project}/keys/{key}". + """ + + key: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GetKeyRequest(proto.Message): + r"""The get key request message. + + Attributes: + name (str): + Required. The name of the requested key, in + the format "projects/{project}/keys/{key}". + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateKeyRequest(proto.Message): + r"""The update key request message. + + Attributes: + key (google.cloud.recaptchaenterprise_v1.types.Key): + Required. The key to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The mask to control which fields of + the key get updated. If the mask is not present, + all fields will be updated. + """ + + key: 'Key' = proto.Field( + proto.MESSAGE, + number=1, + message='Key', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class DeleteKeyRequest(proto.Message): + r"""The delete key request message. + + Attributes: + name (str): + Required. The name of the key to be deleted, + in the format "projects/{project}/keys/{key}". + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class MigrateKeyRequest(proto.Message): + r"""The migrate key request message. + + Attributes: + name (str): + Required. The name of the key to be migrated, + in the format "projects/{project}/keys/{key}". + skip_billing_check (bool): + Optional. If true, skips the billing check. A reCAPTCHA + Enterprise key or migrated key behaves differently than a + reCAPTCHA (non-Enterprise version) key when you reach a + quota limit (see + https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). + To avoid any disruption of your usage, we check that a + billing account is present. If your usage of reCAPTCHA is + under the free quota, you can safely skip the billing check + and proceed with the migration. See + https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + skip_billing_check: bool = proto.Field( + proto.BOOL, + number=2, + ) + + +class GetMetricsRequest(proto.Message): + r"""The get metrics request message. + + Attributes: + name (str): + Required. The name of the requested metrics, + in the format + "projects/{project}/keys/{key}/metrics". + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class Metrics(proto.Message): + r"""Metrics for a single Key. + + Attributes: + name (str): + Output only. The name of the metrics, in the + format "projects/{project}/keys/{key}/metrics". + start_time (google.protobuf.timestamp_pb2.Timestamp): + Inclusive start time aligned to a day (UTC). + score_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ScoreMetrics]): + Metrics will be continuous and in order by + dates, and in the granularity of day. All Key + types should have score-based data. + challenge_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ChallengeMetrics]): + Metrics will be continuous and in order by + dates, and in the granularity of day. Only + challenge-based keys (CHECKBOX, INVISIBLE), will + have challenge-based data. + """ + + name: str = proto.Field( + proto.STRING, + number=4, + ) + start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + score_metrics: MutableSequence['ScoreMetrics'] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='ScoreMetrics', + ) + challenge_metrics: MutableSequence['ChallengeMetrics'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='ChallengeMetrics', + ) + + +class RetrieveLegacySecretKeyResponse(proto.Message): + r"""Secret key is used only in legacy reCAPTCHA. It must be used + in a 3rd party integration with legacy reCAPTCHA. + + Attributes: + legacy_secret_key (str): + The secret key (also known as shared secret) + authorizes communication between your + application backend and the reCAPTCHA Enterprise + server to create an assessment. + The secret key needs to be kept safe for + security purposes. + """ + + legacy_secret_key: str = proto.Field( + proto.STRING, + number=1, + ) + + +class Key(proto.Message): + r"""A key used to identify and configure applications (web and/or + mobile) that use reCAPTCHA Enterprise. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + name (str): + The resource name for the Key in the format + "projects/{project}/keys/{key}". + display_name (str): + Human-readable display name of this key. + Modifiable by user. + web_settings (google.cloud.recaptchaenterprise_v1.types.WebKeySettings): + Settings for keys that can be used by + websites. + + This field is a member of `oneof`_ ``platform_settings``. + android_settings (google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings): + Settings for keys that can be used by Android + apps. + + This field is a member of `oneof`_ ``platform_settings``. + ios_settings (google.cloud.recaptchaenterprise_v1.types.IOSKeySettings): + Settings for keys that can be used by iOS + apps. + + This field is a member of `oneof`_ ``platform_settings``. + labels (MutableMapping[str, str]): + See + Creating and managing labels. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The timestamp corresponding to + the creation of this Key. + testing_options (google.cloud.recaptchaenterprise_v1.types.TestingOptions): + Options for user acceptance testing. + waf_settings (google.cloud.recaptchaenterprise_v1.types.WafSettings): + Settings for WAF + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + display_name: str = proto.Field( + proto.STRING, + number=2, + ) + web_settings: 'WebKeySettings' = proto.Field( + proto.MESSAGE, + number=3, + oneof='platform_settings', + message='WebKeySettings', + ) + android_settings: 'AndroidKeySettings' = proto.Field( + proto.MESSAGE, + number=4, + oneof='platform_settings', + message='AndroidKeySettings', + ) + ios_settings: 'IOSKeySettings' = proto.Field( + proto.MESSAGE, + number=5, + oneof='platform_settings', + message='IOSKeySettings', + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=6, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + testing_options: 'TestingOptions' = proto.Field( + proto.MESSAGE, + number=9, + message='TestingOptions', + ) + waf_settings: 'WafSettings' = proto.Field( + proto.MESSAGE, + number=10, + message='WafSettings', + ) + + +class TestingOptions(proto.Message): + r"""Options for user acceptance testing. + + Attributes: + testing_score (float): + All assessments for this Key will return this + score. Must be between 0 (likely not legitimate) + and 1 (likely legitimate) inclusive. + testing_challenge (google.cloud.recaptchaenterprise_v1.types.TestingOptions.TestingChallenge): + For challenge-based keys only (CHECKBOX, + INVISIBLE), all challenge requests for this site + will return nocaptcha if NOCAPTCHA, or an + unsolvable challenge if CHALLENGE. + """ + class TestingChallenge(proto.Enum): + r"""Enum that represents the challenge option for challenge-based + (CHECKBOX, INVISIBLE) testing keys. + + Values: + TESTING_CHALLENGE_UNSPECIFIED (0): + Perform the normal risk analysis and return + either nocaptcha or a challenge depending on + risk and trust factors. + NOCAPTCHA (1): + Challenge requests for this key always return + a nocaptcha, which does not require a solution. + UNSOLVABLE_CHALLENGE (2): + Challenge requests for this key always return + an unsolvable challenge. + """ + TESTING_CHALLENGE_UNSPECIFIED = 0 + NOCAPTCHA = 1 + UNSOLVABLE_CHALLENGE = 2 + + testing_score: float = proto.Field( + proto.FLOAT, + number=1, + ) + testing_challenge: TestingChallenge = proto.Field( + proto.ENUM, + number=2, + enum=TestingChallenge, + ) + + +class WebKeySettings(proto.Message): + r"""Settings specific to keys that can be used by websites. + + Attributes: + allow_all_domains (bool): + If set to true, it means allowed_domains will not be + enforced. + allowed_domains (MutableSequence[str]): + Domains or subdomains of websites allowed to + use the key. All subdomains of an allowed domain + are automatically allowed. A valid domain + requires a host and must not include any path, + port, query or fragment. Examples: 'example.com' + or 'subdomain.example.com' + allow_amp_traffic (bool): + If set to true, the key can be used on AMP + (Accelerated Mobile Pages) websites. This is + supported only for the SCORE integration type. + integration_type (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType): + Required. Describes how this key is + integrated with the website. + challenge_security_preference (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference): + Settings for the frequency and difficulty at + which this key triggers captcha challenges. This + should only be specified for IntegrationTypes + CHECKBOX and INVISIBLE. + """ + class IntegrationType(proto.Enum): + r"""Enum that represents the integration types for web keys. + + Values: + INTEGRATION_TYPE_UNSPECIFIED (0): + Default type that indicates this enum hasn't + been specified. This is not a valid + IntegrationType, one of the other types must be + specified instead. + SCORE (1): + Only used to produce scores. It doesn't + display the "I'm not a robot" checkbox and never + shows captcha challenges. + CHECKBOX (2): + Displays the "I'm not a robot" checkbox and + may show captcha challenges after it is checked. + INVISIBLE (3): + Doesn't display the "I'm not a robot" + checkbox, but may show captcha challenges after + risk analysis. + """ + INTEGRATION_TYPE_UNSPECIFIED = 0 + SCORE = 1 + CHECKBOX = 2 + INVISIBLE = 3 + + class ChallengeSecurityPreference(proto.Enum): + r"""Enum that represents the possible challenge frequency and + difficulty configurations for a web key. + + Values: + CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED (0): + Default type that indicates this enum hasn't + been specified. + USABILITY (1): + Key tends to show fewer and easier + challenges. + BALANCE (2): + Key tends to show balanced (in amount and + difficulty) challenges. + SECURITY (3): + Key tends to show more and harder challenges. + """ + CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0 + USABILITY = 1 + BALANCE = 2 + SECURITY = 3 + + allow_all_domains: bool = proto.Field( + proto.BOOL, + number=3, + ) + allowed_domains: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + allow_amp_traffic: bool = proto.Field( + proto.BOOL, + number=2, + ) + integration_type: IntegrationType = proto.Field( + proto.ENUM, + number=4, + enum=IntegrationType, + ) + challenge_security_preference: ChallengeSecurityPreference = proto.Field( + proto.ENUM, + number=5, + enum=ChallengeSecurityPreference, + ) + + +class AndroidKeySettings(proto.Message): + r"""Settings specific to keys that can be used by Android apps. + + Attributes: + allow_all_package_names (bool): + If set to true, allowed_package_names are not enforced. + allowed_package_names (MutableSequence[str]): + Android package names of apps allowed to use + the key. Example: 'com.companyname.appname' + """ + + allow_all_package_names: bool = proto.Field( + proto.BOOL, + number=2, + ) + allowed_package_names: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +class IOSKeySettings(proto.Message): + r"""Settings specific to keys that can be used by iOS apps. + + Attributes: + allow_all_bundle_ids (bool): + If set to true, allowed_bundle_ids are not enforced. + allowed_bundle_ids (MutableSequence[str]): + iOS bundle ids of apps allowed to use the + key. Example: + 'com.companyname.productname.appname' + """ + + allow_all_bundle_ids: bool = proto.Field( + proto.BOOL, + number=2, + ) + allowed_bundle_ids: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +class ScoreDistribution(proto.Message): + r"""Score distribution. + + Attributes: + score_buckets (MutableMapping[int, int]): + Map key is score value multiplied by 100. The scores are + discrete values between [0, 1]. The maximum number of + buckets is on order of a few dozen, but typically much lower + (ie. 10). + """ + + score_buckets: MutableMapping[int, int] = proto.MapField( + proto.INT32, + proto.INT64, + number=1, + ) + + +class ScoreMetrics(proto.Message): + r"""Metrics related to scoring. + + Attributes: + overall_metrics (google.cloud.recaptchaenterprise_v1.types.ScoreDistribution): + Aggregated score metrics for all traffic. + action_metrics (MutableMapping[str, google.cloud.recaptchaenterprise_v1.types.ScoreDistribution]): + Action-based metrics. The map key is the + action name which specified by the site owners + at time of the "execute" client-side call. + """ + + overall_metrics: 'ScoreDistribution' = proto.Field( + proto.MESSAGE, + number=1, + message='ScoreDistribution', + ) + action_metrics: MutableMapping[str, 'ScoreDistribution'] = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=2, + message='ScoreDistribution', + ) + + +class ChallengeMetrics(proto.Message): + r"""Metrics related to challenges. + + Attributes: + pageload_count (int): + Count of reCAPTCHA checkboxes or badges + rendered. This is mostly equivalent to a count + of pageloads for pages that include reCAPTCHA. + nocaptcha_count (int): + Count of nocaptchas (successful verification + without a challenge) issued. + failed_count (int): + Count of submitted challenge solutions that + were incorrect or otherwise deemed suspicious + such that a subsequent challenge was triggered. + passed_count (int): + Count of nocaptchas (successful verification + without a challenge) plus submitted challenge + solutions that were correct and resulted in + verification. + """ + + pageload_count: int = proto.Field( + proto.INT64, + number=1, + ) + nocaptcha_count: int = proto.Field( + proto.INT64, + number=2, + ) + failed_count: int = proto.Field( + proto.INT64, + number=3, + ) + passed_count: int = proto.Field( + proto.INT64, + number=4, + ) + + +class ListRelatedAccountGroupMembershipsRequest(proto.Message): + r"""The request message to list memberships in a related account + group. + + Attributes: + parent (str): + Required. The resource name for the related account group in + the format + ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. + page_size (int): + Optional. The maximum number of accounts to + return. The service might return fewer than this + value. If unspecified, at most 50 accounts are + returned. The maximum value is 1000; values + above 1000 are coerced to 1000. + page_token (str): + Optional. A page token, received from a previous + ``ListRelatedAccountGroupMemberships`` call. + + When paginating, all other parameters provided to + ``ListRelatedAccountGroupMemberships`` must match the call + that provided the page token. + """ + + 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 ListRelatedAccountGroupMembershipsResponse(proto.Message): + r"""The response to a ``ListRelatedAccountGroupMemberships`` call. + + Attributes: + related_account_group_memberships (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroupMembership]): + The memberships listed by the query. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + related_account_group_memberships: MutableSequence['RelatedAccountGroupMembership'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RelatedAccountGroupMembership', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ListRelatedAccountGroupsRequest(proto.Message): + r"""The request message to list related account groups. + + Attributes: + parent (str): + Required. The name of the project to list + related account groups from, in the format + "projects/{project}". + page_size (int): + Optional. The maximum number of groups to + return. The service might return fewer than this + value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values + above 1000 are coerced to 1000. + page_token (str): + Optional. A page token, received from a previous + ``ListRelatedAccountGroups`` call. Provide this to retrieve + the subsequent page. + + When paginating, all other parameters provided to + ``ListRelatedAccountGroups`` must match the call that + provided the page token. + """ + + 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 ListRelatedAccountGroupsResponse(proto.Message): + r"""The response to a ``ListRelatedAccountGroups`` call. + + Attributes: + related_account_groups (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroup]): + The groups of related accounts listed by the + query. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + related_account_groups: MutableSequence['RelatedAccountGroup'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RelatedAccountGroup', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchRelatedAccountGroupMembershipsRequest(proto.Message): + r"""The request message to search related account group + memberships. + + Attributes: + project (str): + Required. The name of the project to search + related account group memberships from. Specify + the project name in the following format: + "projects/{project}". + hashed_account_id (bytes): + Optional. The unique stable hashed user identifier we should + search connections to. The identifier should correspond to a + ``hashed_account_id`` provided in a previous + ``CreateAssessment`` or ``AnnotateAssessment`` call. + page_size (int): + Optional. The maximum number of groups to + return. The service might return fewer than this + value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values + above 1000 are coerced to 1000. + page_token (str): + Optional. A page token, received from a previous + ``SearchRelatedAccountGroupMemberships`` call. Provide this + to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``SearchRelatedAccountGroupMemberships`` must match the call + that provided the page token. + """ + + project: str = proto.Field( + proto.STRING, + number=1, + ) + hashed_account_id: bytes = proto.Field( + proto.BYTES, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchRelatedAccountGroupMembershipsResponse(proto.Message): + r"""The response to a ``SearchRelatedAccountGroupMemberships`` call. + + Attributes: + related_account_group_memberships (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroupMembership]): + The queried memberships. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + related_account_group_memberships: MutableSequence['RelatedAccountGroupMembership'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RelatedAccountGroupMembership', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class RelatedAccountGroupMembership(proto.Message): + r"""A membership in a group of related accounts. + + Attributes: + name (str): + Required. The resource name for this membership in the + format + ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}``. + hashed_account_id (bytes): + The unique stable hashed user identifier of the member. The + identifier corresponds to a ``hashed_account_id`` provided + in a previous ``CreateAssessment`` or ``AnnotateAssessment`` + call. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + hashed_account_id: bytes = proto.Field( + proto.BYTES, + number=2, + ) + + +class RelatedAccountGroup(proto.Message): + r"""A group of related accounts. + + Attributes: + name (str): + Required. The resource name for the related account group in + the format + ``projects/{project}/relatedaccountgroups/{related_account_group}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class WafSettings(proto.Message): + r"""Settings specific to keys that can be used for WAF (Web + Application Firewall). + + Attributes: + waf_service (google.cloud.recaptchaenterprise_v1.types.WafSettings.WafService): + Required. The WAF service that uses this key. + waf_feature (google.cloud.recaptchaenterprise_v1.types.WafSettings.WafFeature): + Required. The WAF feature for which this key + is enabled. + """ + class WafFeature(proto.Enum): + r"""Supported WAF features. For more information, see + https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. + + Values: + WAF_FEATURE_UNSPECIFIED (0): + Undefined feature. + CHALLENGE_PAGE (1): + Redirects suspicious traffic to reCAPTCHA. + SESSION_TOKEN (2): + Use reCAPTCHA session-tokens to protect the + whole user session on the site's domain. + ACTION_TOKEN (3): + Use reCAPTCHA action-tokens to protect user + actions. + """ + WAF_FEATURE_UNSPECIFIED = 0 + CHALLENGE_PAGE = 1 + SESSION_TOKEN = 2 + ACTION_TOKEN = 3 + + class WafService(proto.Enum): + r"""Web Application Firewalls supported by reCAPTCHA Enterprise. + + Values: + WAF_SERVICE_UNSPECIFIED (0): + Undefined WAF + CA (1): + Cloud Armor + """ + WAF_SERVICE_UNSPECIFIED = 0 + CA = 1 + + waf_service: WafService = proto.Field( + proto.ENUM, + number=1, + enum=WafService, + ) + waf_feature: WafFeature = proto.Field( + proto.ENUM, + number=2, + enum=WafFeature, + ) + + +__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..9e4d88e --- /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/recaptchaenterprise_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/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py new file mode 100644 index 0000000..c903689 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_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 AnnotateAssessment +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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 recaptchaenterprise_v1 + + +async def sample_annotate_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.AnnotateAssessmentRequest( + name="name_value", + ) + + # Make the request + response = await client.annotate_assessment(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py new file mode 100644 index 0000000..0de2446 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_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 AnnotateAssessment +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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 recaptchaenterprise_v1 + + +def sample_annotate_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.AnnotateAssessmentRequest( + name="name_value", + ) + + # Make the request + response = client.annotate_assessment(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py new file mode 100644 index 0000000..81d548c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_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 CreateAssessment +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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 recaptchaenterprise_v1 + + +async def sample_create_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.CreateAssessmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_assessment(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py new file mode 100644 index 0000000..6cadb97 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_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 CreateAssessment +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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 recaptchaenterprise_v1 + + +def sample_create_assessment(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.CreateAssessmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_assessment(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py new file mode 100644 index 0000000..1ce14bf --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py @@ -0,0 +1,56 @@ +# -*- 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 CreateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_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 recaptchaenterprise_v1 + + +async def sample_create_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.CreateKeyRequest( + parent="parent_value", + key=key, + ) + + # Make the request + response = await client.create_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py new file mode 100644 index 0000000..b989397 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py @@ -0,0 +1,56 @@ +# -*- 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 CreateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_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 recaptchaenterprise_v1 + + +def sample_create_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.CreateKeyRequest( + parent="parent_value", + key=key, + ) + + # Make the request + response = client.create_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py new file mode 100644 index 0000000..cc6c535 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_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 DeleteKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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 recaptchaenterprise_v1 + + +async def sample_delete_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.DeleteKeyRequest( + name="name_value", + ) + + # Make the request + await client.delete_key(request=request) + + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py new file mode 100644 index 0000000..78a8781 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_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 DeleteKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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 recaptchaenterprise_v1 + + +def sample_delete_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.DeleteKeyRequest( + name="name_value", + ) + + # Make the request + client.delete_key(request=request) + + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py new file mode 100644 index 0000000..077d790 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_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 GetKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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 recaptchaenterprise_v1 + + +async def sample_get_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.get_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py new file mode 100644 index 0000000..8dee0f8 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_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 GetKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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 recaptchaenterprise_v1 + + +def sample_get_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetKeyRequest( + name="name_value", + ) + + # Make the request + response = client.get_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py new file mode 100644 index 0000000..fbd89ea --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_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 GetMetrics +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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 recaptchaenterprise_v1 + + +async def sample_get_metrics(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetMetricsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_metrics(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py new file mode 100644 index 0000000..0a1c13b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_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 GetMetrics +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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 recaptchaenterprise_v1 + + +def sample_get_metrics(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.GetMetricsRequest( + name="name_value", + ) + + # Make the request + response = client.get_metrics(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py new file mode 100644 index 0000000..f296b28 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_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 ListKeys +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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 recaptchaenterprise_v1 + + +async def sample_list_keys(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListKeysRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_keys(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py new file mode 100644 index 0000000..b0886b4 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_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 ListKeys +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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 recaptchaenterprise_v1 + + +def sample_list_keys(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListKeysRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_keys(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py new file mode 100644 index 0000000..84d380a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_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 ListRelatedAccountGroupMemberships +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 + + +async def sample_list_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_group_memberships(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py new file mode 100644 index 0000000..35b366a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_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 ListRelatedAccountGroupMemberships +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 + + +def sample_list_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_group_memberships(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py new file mode 100644 index 0000000..7e3b070 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_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 ListRelatedAccountGroups +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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 recaptchaenterprise_v1 + + +async def sample_list_related_account_groups(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_groups(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py new file mode 100644 index 0000000..ae32505 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_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 ListRelatedAccountGroups +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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 recaptchaenterprise_v1 + + +def sample_list_related_account_groups(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_related_account_groups(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py new file mode 100644 index 0000000..1559c00 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_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 MigrateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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 recaptchaenterprise_v1 + + +async def sample_migrate_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.MigrateKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.migrate_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py new file mode 100644 index 0000000..731ce33 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_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 MigrateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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 recaptchaenterprise_v1 + + +def sample_migrate_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.MigrateKeyRequest( + name="name_value", + ) + + # Make the request + response = client.migrate_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py new file mode 100644 index 0000000..23e9e9a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_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 RetrieveLegacySecretKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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 recaptchaenterprise_v1 + + +async def sample_retrieve_legacy_secret_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( + key="key_value", + ) + + # Make the request + response = await client.retrieve_legacy_secret_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py new file mode 100644 index 0000000..74fd8a1 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_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 RetrieveLegacySecretKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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 recaptchaenterprise_v1 + + +def sample_retrieve_legacy_secret_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( + key="key_value", + ) + + # Make the request + response = client.retrieve_legacy_secret_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py new file mode 100644 index 0000000..e84bcda --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_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 SearchRelatedAccountGroupMemberships +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 + + +async def sample_search_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( + project="project_value", + ) + + # Make the request + page_result = client.search_related_account_group_memberships(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py new file mode 100644 index 0000000..f9151a1 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_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 SearchRelatedAccountGroupMemberships +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 + + +def sample_search_related_account_group_memberships(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( + project="project_value", + ) + + # Make the request + page_result = client.search_related_account_group_memberships(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py new file mode 100644 index 0000000..1123d57 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py @@ -0,0 +1,55 @@ +# -*- 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 UpdateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_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 recaptchaenterprise_v1 + + +async def sample_update_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.UpdateKeyRequest( + key=key, + ) + + # Make the request + response = await client.update_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py new file mode 100644 index 0000000..521208f --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py @@ -0,0 +1,55 @@ +# -*- 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 UpdateKey +# 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-recaptcha-enterprise + + +# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_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 recaptchaenterprise_v1 + + +def sample_update_key(): + # Create a client + client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() + + # Initialize request argument(s) + key = recaptchaenterprise_v1.Key() + key.web_settings.integration_type = "INVISIBLE" + + request = recaptchaenterprise_v1.UpdateKeyRequest( + key=key, + ) + + # Make the request + response = client.update_key(request=request) + + # Handle the response + print(response) + +# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json new file mode 100644 index 0000000..f229f1b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json @@ -0,0 +1,2134 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.recaptchaenterprise.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-recaptcha-enterprise", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.annotate_assessment", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessment", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "AnnotateAssessment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "annotation", + "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse", + "shortName": "annotate_assessment" + }, + "description": "Sample for AnnotateAssessment", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.annotate_assessment", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessment", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "AnnotateAssessment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "annotation", + "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse", + "shortName": "annotate_assessment" + }, + "description": "Sample for AnnotateAssessment", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.create_assessment", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessment", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "CreateAssessment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "assessment", + "type": "google.cloud.recaptchaenterprise_v1.types.Assessment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Assessment", + "shortName": "create_assessment" + }, + "description": "Sample for CreateAssessment", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.create_assessment", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessment", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "CreateAssessment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "assessment", + "type": "google.cloud.recaptchaenterprise_v1.types.Assessment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Assessment", + "shortName": "create_assessment" + }, + "description": "Sample for CreateAssessment", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.create_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "CreateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "key", + "type": "google.cloud.recaptchaenterprise_v1.types.Key" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", + "shortName": "create_key" + }, + "description": "Sample for CreateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.create_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "CreateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "key", + "type": "google.cloud.recaptchaenterprise_v1.types.Key" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", + "shortName": "create_key" + }, + "description": "Sample for CreateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.delete_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "DeleteKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest" + }, + { + "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_key" + }, + "description": "Sample for DeleteKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.delete_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "DeleteKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest" + }, + { + "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_key" + }, + "description": "Sample for DeleteKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.get_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "GetKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.GetKeyRequest" + }, + { + "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.recaptchaenterprise_v1.types.Key", + "shortName": "get_key" + }, + "description": "Sample for GetKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.get_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "GetKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.GetKeyRequest" + }, + { + "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.recaptchaenterprise_v1.types.Key", + "shortName": "get_key" + }, + "description": "Sample for GetKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.get_metrics", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetrics", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "GetMetrics" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest" + }, + { + "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.recaptchaenterprise_v1.types.Metrics", + "shortName": "get_metrics" + }, + "description": "Sample for GetMetrics", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.get_metrics", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetrics", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "GetMetrics" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest" + }, + { + "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.recaptchaenterprise_v1.types.Metrics", + "shortName": "get_metrics" + }, + "description": "Sample for GetMetrics", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_keys", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeys", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListKeys" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListKeysRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager", + "shortName": "list_keys" + }, + "description": "Sample for ListKeys", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_keys", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeys", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListKeys" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListKeysRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager", + "shortName": "list_keys" + }, + "description": "Sample for ListKeys", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_related_account_group_memberships", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMemberships", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListRelatedAccountGroupMemberships" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager", + "shortName": "list_related_account_group_memberships" + }, + "description": "Sample for ListRelatedAccountGroupMemberships", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_related_account_group_memberships", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMemberships", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListRelatedAccountGroupMemberships" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager", + "shortName": "list_related_account_group_memberships" + }, + "description": "Sample for ListRelatedAccountGroupMemberships", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_related_account_groups", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroups", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListRelatedAccountGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager", + "shortName": "list_related_account_groups" + }, + "description": "Sample for ListRelatedAccountGroups", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_related_account_groups", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroups", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "ListRelatedAccountGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest" + }, + { + "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager", + "shortName": "list_related_account_groups" + }, + "description": "Sample for ListRelatedAccountGroups", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.migrate_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "MigrateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", + "shortName": "migrate_key" + }, + "description": "Sample for MigrateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.migrate_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "MigrateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", + "shortName": "migrate_key" + }, + "description": "Sample for MigrateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.retrieve_legacy_secret_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "RetrieveLegacySecretKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest" + }, + { + "name": "key", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse", + "shortName": "retrieve_legacy_secret_key" + }, + "description": "Sample for RetrieveLegacySecretKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.retrieve_legacy_secret_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "RetrieveLegacySecretKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest" + }, + { + "name": "key", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse", + "shortName": "retrieve_legacy_secret_key" + }, + "description": "Sample for RetrieveLegacySecretKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.search_related_account_group_memberships", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMemberships", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "SearchRelatedAccountGroupMemberships" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "hashed_account_id", + "type": "bytes" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager", + "shortName": "search_related_account_group_memberships" + }, + "description": "Sample for SearchRelatedAccountGroupMemberships", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.search_related_account_group_memberships", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMemberships", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "SearchRelatedAccountGroupMemberships" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "hashed_account_id", + "type": "bytes" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager", + "shortName": "search_related_account_group_memberships" + }, + "description": "Sample for SearchRelatedAccountGroupMemberships", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", + "shortName": "RecaptchaEnterpriseServiceAsyncClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.update_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "UpdateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest" + }, + { + "name": "key", + "type": "google.cloud.recaptchaenterprise_v1.types.Key" + }, + { + "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.recaptchaenterprise_v1.types.Key", + "shortName": "update_key" + }, + "description": "Sample for UpdateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", + "shortName": "RecaptchaEnterpriseServiceClient" + }, + "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.update_key", + "method": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKey", + "service": { + "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", + "shortName": "RecaptchaEnterpriseService" + }, + "shortName": "UpdateKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest" + }, + { + "name": "key", + "type": "google.cloud.recaptchaenterprise_v1.types.Key" + }, + { + "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.recaptchaenterprise_v1.types.Key", + "shortName": "update_key" + }, + "description": "Sample for UpdateKey", + "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py new file mode 100644 index 0000000..16b5787 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py @@ -0,0 +1,188 @@ +#! /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 recaptchaenterpriseCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'annotate_assessment': ('name', 'annotation', 'reasons', 'hashed_account_id', 'transaction_event', ), + 'create_assessment': ('parent', 'assessment', ), + 'create_key': ('parent', 'key', ), + 'delete_key': ('name', ), + 'get_key': ('name', ), + 'get_metrics': ('name', ), + 'list_keys': ('parent', 'page_size', 'page_token', ), + 'list_related_account_group_memberships': ('parent', 'page_size', 'page_token', ), + 'list_related_account_groups': ('parent', 'page_size', 'page_token', ), + 'migrate_key': ('name', 'skip_billing_check', ), + 'retrieve_legacy_secret_key': ('key', ), + 'search_related_account_group_memberships': ('project', 'hashed_account_id', 'page_size', 'page_token', ), + 'update_key': ('key', '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=recaptchaenterpriseCallTransformer(), +): + """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 recaptchaenterprise 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..e2ae993 --- /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-recaptcha-enterprise' + + +description = "Google Cloud Recaptcha Enterprise API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/recaptchaenterprise/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-recaptcha-enterprise" + +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/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_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/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py new file mode 100644 index 0000000..020ea8f --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py @@ -0,0 +1,4996 @@ +# -*- 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 +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers + +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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers +from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import transports +from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise +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 RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(None) is None + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (RecaptchaEnterpriseServiceClient, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_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 == ( + 'recaptchaenterprise.googleapis.com:443' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_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", [ + (RecaptchaEnterpriseServiceClient, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_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 == ( + 'recaptchaenterprise.googleapis.com:443' + ) + + +def test_recaptcha_enterprise_service_client_get_transport_class(): + transport = RecaptchaEnterpriseServiceClient.get_transport_class() + available_transports = [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + ] + assert transport in available_transports + + transport = RecaptchaEnterpriseServiceClient.get_transport_class("grpc") + assert transport == transports.RecaptchaEnterpriseServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) +@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) +def test_recaptcha_enterprise_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(RecaptchaEnterpriseServiceClient, '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(RecaptchaEnterpriseServiceClient, '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", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "true"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "false"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) +@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_recaptcha_enterprise_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", [ + RecaptchaEnterpriseServiceClient, RecaptchaEnterpriseServiceAsyncClient +]) +@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) +@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) +def test_recaptcha_enterprise_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", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_recaptcha_enterprise_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", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", grpc_helpers), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_recaptcha_enterprise_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_recaptcha_enterprise_service_client_client_options_from_dict(): + with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = RecaptchaEnterpriseServiceClient( + 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", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", grpc_helpers), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_recaptcha_enterprise_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( + "recaptchaenterprise.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="recaptchaenterprise.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.CreateAssessmentRequest, + dict, +]) +def test_create_assessment(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment( + name='name_value', + ) + response = client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Assessment) + assert response.name == 'name_value' + + +def test_create_assessment_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 = RecaptchaEnterpriseServiceClient( + 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_assessment), + '__call__') as call: + client.create_assessment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + +@pytest.mark.asyncio +async def test_create_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateAssessmentRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment( + name='name_value', + )) + response = await client.create_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Assessment) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_create_assessment_async_from_dict(): + await test_create_assessment_async(request_type=dict) + + +def test_create_assessment_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.CreateAssessmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + call.return_value = recaptchaenterprise.Assessment() + client.create_assessment(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_assessment_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.CreateAssessmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) + await client.create_assessment(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_assessment_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_assessment( + parent='parent_value', + assessment=recaptchaenterprise.Assessment(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].assessment + mock_val = recaptchaenterprise.Assessment(name='name_value') + assert arg == mock_val + + +def test_create_assessment_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_assessment( + recaptchaenterprise.CreateAssessmentRequest(), + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_assessment_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Assessment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_assessment( + parent='parent_value', + assessment=recaptchaenterprise.Assessment(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].assessment + mock_val = recaptchaenterprise.Assessment(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_assessment_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_assessment( + recaptchaenterprise.CreateAssessmentRequest(), + parent='parent_value', + assessment=recaptchaenterprise.Assessment(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.AnnotateAssessmentRequest, + dict, +]) +def test_annotate_assessment(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse( + ) + response = client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) + + +def test_annotate_assessment_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 = RecaptchaEnterpriseServiceClient( + 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.annotate_assessment), + '__call__') as call: + client.annotate_assessment() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + +@pytest.mark.asyncio +async def test_annotate_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.AnnotateAssessmentRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse( + )) + response = await client.annotate_assessment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) + + +@pytest.mark.asyncio +async def test_annotate_assessment_async_from_dict(): + await test_annotate_assessment_async(request_type=dict) + + +def test_annotate_assessment_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.AnnotateAssessmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + client.annotate_assessment(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_annotate_assessment_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.AnnotateAssessmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) + await client.annotate_assessment(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_annotate_assessment_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.annotate_assessment( + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + # 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 + arg = args[0].annotation + mock_val = recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE + assert arg == mock_val + + +def test_annotate_assessment_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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.annotate_assessment( + recaptchaenterprise.AnnotateAssessmentRequest(), + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + +@pytest.mark.asyncio +async def test_annotate_assessment_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.annotate_assessment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.annotate_assessment( + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + # 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 + arg = args[0].annotation + mock_val = recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE + assert arg == mock_val + +@pytest.mark.asyncio +async def test_annotate_assessment_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.annotate_assessment( + recaptchaenterprise.AnnotateAssessmentRequest(), + name='name_value', + annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.CreateKeyRequest, + dict, +]) +def test_create_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_create_key_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 = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + client.create_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + +@pytest.mark.asyncio +async def test_create_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.create_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.CreateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_create_key_async_from_dict(): + await test_create_key_async(request_type=dict) + + +def test_create_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.CreateKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.create_key(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_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.CreateKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.create_key(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_key_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_key( + parent='parent_value', + key=recaptchaenterprise.Key(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].key + mock_val = recaptchaenterprise.Key(name='name_value') + assert arg == mock_val + + +def test_create_key_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_key( + recaptchaenterprise.CreateKeyRequest(), + parent='parent_value', + key=recaptchaenterprise.Key(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_key_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_key( + parent='parent_value', + key=recaptchaenterprise.Key(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].key + mock_val = recaptchaenterprise.Key(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_key_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key( + recaptchaenterprise.CreateKeyRequest(), + parent='parent_value', + key=recaptchaenterprise.Key(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.ListKeysRequest, + dict, +]) +def test_list_keys(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListKeysResponse( + next_page_token='next_page_token_value', + ) + response = client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListKeysPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_keys_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 = RecaptchaEnterpriseServiceClient( + 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_keys), + '__call__') as call: + client.list_keys() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + +@pytest.mark.asyncio +async def test_list_keys_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListKeysRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_keys(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListKeysRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListKeysAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_keys_async_from_dict(): + await test_list_keys_async(request_type=dict) + + +def test_list_keys_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.ListKeysRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + call.return_value = recaptchaenterprise.ListKeysResponse() + client.list_keys(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_keys_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.ListKeysRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) + await client.list_keys(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_keys_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListKeysResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_keys( + 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_keys_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_keys( + recaptchaenterprise.ListKeysRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_keys_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListKeysResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_keys( + 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_keys_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_keys( + recaptchaenterprise.ListKeysRequest(), + parent='parent_value', + ) + + +def test_list_keys_pager(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_keys), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_keys(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recaptchaenterprise.Key) + for i in results) +def test_list_keys_pages(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_keys), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + pages = list(client.list_keys(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_keys_async_pager(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_keys(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, recaptchaenterprise.Key) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_keys_async_pages(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_keys), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListKeysResponse( + keys=[], + next_page_token='def', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListKeysResponse( + keys=[ + recaptchaenterprise.Key(), + recaptchaenterprise.Key(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_keys(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", [ + recaptchaenterprise.RetrieveLegacySecretKeyRequest, + dict, +]) +def test_retrieve_legacy_secret_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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.retrieve_legacy_secret_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse( + legacy_secret_key='legacy_secret_key_value', + ) + response = client.retrieve_legacy_secret_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.RetrieveLegacySecretKeyResponse) + assert response.legacy_secret_key == 'legacy_secret_key_value' + + +def test_retrieve_legacy_secret_key_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 = RecaptchaEnterpriseServiceClient( + 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.retrieve_legacy_secret_key), + '__call__') as call: + client.retrieve_legacy_secret_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() + +@pytest.mark.asyncio +async def test_retrieve_legacy_secret_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.RetrieveLegacySecretKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.retrieve_legacy_secret_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse( + legacy_secret_key='legacy_secret_key_value', + )) + response = await client.retrieve_legacy_secret_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.RetrieveLegacySecretKeyResponse) + assert response.legacy_secret_key == 'legacy_secret_key_value' + + +@pytest.mark.asyncio +async def test_retrieve_legacy_secret_key_async_from_dict(): + await test_retrieve_legacy_secret_key_async(request_type=dict) + + +def test_retrieve_legacy_secret_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest() + + request.key = 'key_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_legacy_secret_key), + '__call__') as call: + call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() + client.retrieve_legacy_secret_key(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', + 'key=key_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_retrieve_legacy_secret_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest() + + request.key = 'key_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_legacy_secret_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse()) + await client.retrieve_legacy_secret_key(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', + 'key=key_value', + ) in kw['metadata'] + + +def test_retrieve_legacy_secret_key_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_legacy_secret_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.retrieve_legacy_secret_key( + key='key_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].key + mock_val = 'key_value' + assert arg == mock_val + + +def test_retrieve_legacy_secret_key_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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.retrieve_legacy_secret_key( + recaptchaenterprise.RetrieveLegacySecretKeyRequest(), + key='key_value', + ) + +@pytest.mark.asyncio +async def test_retrieve_legacy_secret_key_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.retrieve_legacy_secret_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.retrieve_legacy_secret_key( + key='key_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].key + mock_val = 'key_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_retrieve_legacy_secret_key_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.retrieve_legacy_secret_key( + recaptchaenterprise.RetrieveLegacySecretKeyRequest(), + key='key_value', + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.GetKeyRequest, + dict, +]) +def test_get_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_get_key_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 = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + client.get_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + +@pytest.mark.asyncio +async def test_get_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.get_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_get_key_async_from_dict(): + await test_get_key_async(request_type=dict) + + +def test_get_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.GetKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.get_key(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_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.GetKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.get_key(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_key_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_key( + 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_key_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_key( + recaptchaenterprise.GetKeyRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_key_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_key( + 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_key_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key( + recaptchaenterprise.GetKeyRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.UpdateKeyRequest, + dict, +]) +def test_update_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_update_key_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 = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + client.update_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + +@pytest.mark.asyncio +async def test_update_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.UpdateKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.update_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.UpdateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_update_key_async_from_dict(): + await test_update_key_async(request_type=dict) + + +def test_update_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.UpdateKeyRequest() + + request.key.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.update_key(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', + 'key.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.UpdateKeyRequest() + + request.key.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.update_key(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', + 'key.name=name_value', + ) in kw['metadata'] + + +def test_update_key_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_key( + key=recaptchaenterprise.Key(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].key + mock_val = recaptchaenterprise.Key(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_key_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_key( + recaptchaenterprise.UpdateKeyRequest(), + key=recaptchaenterprise.Key(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_key_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_key( + key=recaptchaenterprise.Key(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].key + mock_val = recaptchaenterprise.Key(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_key_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key( + recaptchaenterprise.UpdateKeyRequest(), + key=recaptchaenterprise.Key(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.DeleteKeyRequest, + dict, +]) +def test_delete_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_key_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 = RecaptchaEnterpriseServiceClient( + 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_key), + '__call__') as call: + client.delete_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + +@pytest.mark.asyncio +async def test_delete_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.DeleteKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.DeleteKeyRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_key_async_from_dict(): + await test_delete_key_async(request_type=dict) + + +def test_delete_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.DeleteKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + call.return_value = None + client.delete_key(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_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.DeleteKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_key(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_key_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__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_key( + 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_key_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_key( + recaptchaenterprise.DeleteKeyRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_key_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_key), + '__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_key( + 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_key_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_key( + recaptchaenterprise.DeleteKeyRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.MigrateKeyRequest, + dict, +]) +def test_migrate_key(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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.migrate_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), + ) + response = client.migrate_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.MigrateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +def test_migrate_key_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 = RecaptchaEnterpriseServiceClient( + 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.migrate_key), + '__call__') as call: + client.migrate_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.MigrateKeyRequest() + +@pytest.mark.asyncio +async def test_migrate_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.MigrateKeyRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.migrate_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( + name='name_value', + display_name='display_name_value', + )) + response = await client.migrate_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.MigrateKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Key) + assert response.name == 'name_value' + assert response.display_name == 'display_name_value' + + +@pytest.mark.asyncio +async def test_migrate_key_async_from_dict(): + await test_migrate_key_async(request_type=dict) + + +def test_migrate_key_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.MigrateKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.migrate_key), + '__call__') as call: + call.return_value = recaptchaenterprise.Key() + client.migrate_key(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_migrate_key_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.MigrateKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.migrate_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) + await client.migrate_key(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'] + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.GetMetricsRequest, + dict, +]) +def test_get_metrics(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_metrics), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Metrics( + name='name_value', + ) + response = client.get_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetMetricsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Metrics) + assert response.name == 'name_value' + + +def test_get_metrics_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 = RecaptchaEnterpriseServiceClient( + 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_metrics), + '__call__') as call: + client.get_metrics() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetMetricsRequest() + +@pytest.mark.asyncio +async def test_get_metrics_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetMetricsRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_metrics), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics( + name='name_value', + )) + response = await client.get_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.GetMetricsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, recaptchaenterprise.Metrics) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_metrics_async_from_dict(): + await test_get_metrics_async(request_type=dict) + + +def test_get_metrics_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.GetMetricsRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_metrics), + '__call__') as call: + call.return_value = recaptchaenterprise.Metrics() + client.get_metrics(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_metrics_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.GetMetricsRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_metrics), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics()) + await client.get_metrics(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_metrics_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_metrics), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Metrics() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_metrics( + 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_metrics_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_metrics( + recaptchaenterprise.GetMetricsRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_metrics_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_metrics), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.Metrics() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_metrics( + 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_metrics_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_metrics( + recaptchaenterprise.GetMetricsRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + recaptchaenterprise.ListRelatedAccountGroupsRequest, + dict, +]) +def test_list_related_account_groups(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_related_account_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRelatedAccountGroupsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_related_account_groups_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 = RecaptchaEnterpriseServiceClient( + 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_related_account_groups), + '__call__') as call: + client.list_related_account_groups() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() + +@pytest.mark.asyncio +async def test_list_related_account_groups_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListRelatedAccountGroupsRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_related_account_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_related_account_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRelatedAccountGroupsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_related_account_groups_async_from_dict(): + await test_list_related_account_groups_async(request_type=dict) + + +def test_list_related_account_groups_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__') as call: + call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() + client.list_related_account_groups(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_related_account_groups_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse()) + await client.list_related_account_groups(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_related_account_groups_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_related_account_groups( + 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_related_account_groups_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_groups( + recaptchaenterprise.ListRelatedAccountGroupsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_related_account_groups_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_related_account_groups( + 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_related_account_groups_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_related_account_groups( + recaptchaenterprise.ListRelatedAccountGroupsRequest(), + parent='parent_value', + ) + + +def test_list_related_account_groups_pager(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_groups), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_related_account_groups(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroup) + for i in results) +def test_list_related_account_groups_pages(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_groups), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + ), + RuntimeError, + ) + pages = list(client.list_related_account_groups(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_related_account_groups_async_pager(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_related_account_groups(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, recaptchaenterprise.RelatedAccountGroup) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_related_account_groups_async_pages(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_groups), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupsResponse( + related_account_groups=[ + recaptchaenterprise.RelatedAccountGroup(), + recaptchaenterprise.RelatedAccountGroup(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_related_account_groups(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", [ + recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, + dict, +]) +def test_list_related_account_group_memberships(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_related_account_group_memberships(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRelatedAccountGroupMembershipsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_related_account_group_memberships_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 = RecaptchaEnterpriseServiceClient( + 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_related_account_group_memberships), + '__call__') as call: + client.list_related_account_group_memberships() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() + +@pytest.mark.asyncio +async def test_list_related_account_group_memberships_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_related_account_group_memberships(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRelatedAccountGroupMembershipsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_related_account_group_memberships_async_from_dict(): + await test_list_related_account_group_memberships_async(request_type=dict) + + +def test_list_related_account_group_memberships_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__') as call: + call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() + client.list_related_account_group_memberships(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_related_account_group_memberships_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse()) + await client.list_related_account_group_memberships(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_related_account_group_memberships_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_related_account_group_memberships( + 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_related_account_group_memberships_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_group_memberships( + recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_related_account_group_memberships_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_related_account_group_memberships( + 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_related_account_group_memberships_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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_related_account_group_memberships( + recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(), + parent='parent_value', + ) + + +def test_list_related_account_group_memberships_pager(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_group_memberships), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_related_account_group_memberships(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroupMembership) + for i in results) +def test_list_related_account_group_memberships_pages(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + 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_related_account_group_memberships), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + pages = list(client.list_related_account_group_memberships(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_related_account_group_memberships_async_pager(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_related_account_group_memberships(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, recaptchaenterprise.RelatedAccountGroupMembership) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_related_account_group_memberships_async_pages(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_related_account_group_memberships), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_related_account_group_memberships(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", [ + recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, + dict, +]) +def test_search_related_account_group_memberships(request_type, transport: str = 'grpc'): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_related_account_group_memberships(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchRelatedAccountGroupMembershipsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_related_account_group_memberships_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 = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + client.search_related_account_group_memberships() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_related_account_group_memberships(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchRelatedAccountGroupMembershipsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_async_from_dict(): + await test_search_related_account_group_memberships_async(request_type=dict) + + +def test_search_related_account_group_memberships_field_headers(): + client = RecaptchaEnterpriseServiceClient( + 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() + + request.project = 'project_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() + client.search_related_account_group_memberships(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', + 'project=project_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_field_headers_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() + + request.project = 'project_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse()) + await client.search_related_account_group_memberships(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', + 'project=project_value', + ) in kw['metadata'] + + +def test_search_related_account_group_memberships_flattened(): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_related_account_group_memberships( + project='project_value', + hashed_account_id=b'hashed_account_id_blob', + ) + + # 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].project + mock_val = 'project_value' + assert arg == mock_val + arg = args[0].hashed_account_id + mock_val = b'hashed_account_id_blob' + assert arg == mock_val + + +def test_search_related_account_group_memberships_flattened_error(): + client = RecaptchaEnterpriseServiceClient( + 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.search_related_account_group_memberships( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(), + project='project_value', + hashed_account_id=b'hashed_account_id_blob', + ) + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_flattened_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_related_account_group_memberships( + project='project_value', + hashed_account_id=b'hashed_account_id_blob', + ) + + # 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].project + mock_val = 'project_value' + assert arg == mock_val + arg = args[0].hashed_account_id + mock_val = b'hashed_account_id_blob' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_flattened_error_async(): + client = RecaptchaEnterpriseServiceAsyncClient( + 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.search_related_account_group_memberships( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(), + project='project_value', + hashed_account_id=b'hashed_account_id_blob', + ) + + +def test_search_related_account_group_memberships_pager(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('project', ''), + )), + ) + pager = client.search_related_account_group_memberships(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroupMembership) + for i in results) +def test_search_related_account_group_memberships_pages(transport_name: str = "grpc"): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + pages = list(client.search_related_account_group_memberships(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_async_pager(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_related_account_group_memberships(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, recaptchaenterprise.RelatedAccountGroupMembership) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_related_account_group_memberships_async_pages(): + client = RecaptchaEnterpriseServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_related_account_group_memberships), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='abc', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[], + next_page_token='def', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + next_page_token='ghi', + ), + recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( + related_account_group_memberships=[ + recaptchaenterprise.RelatedAccountGroupMembership(), + recaptchaenterprise.RelatedAccountGroupMembership(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.search_related_account_group_memberships(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 + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + 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 = RecaptchaEnterpriseServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecaptchaEnterpriseServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecaptchaEnterpriseServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, +]) +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", +]) +def test_transport_kind(transport_name): + transport = RecaptchaEnterpriseServiceClient.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 = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecaptchaEnterpriseServiceGrpcTransport, + ) + +def test_recaptcha_enterprise_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_recaptcha_enterprise_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.RecaptchaEnterpriseServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_assessment', + 'annotate_assessment', + 'create_key', + 'list_keys', + 'retrieve_legacy_secret_key', + 'get_key', + 'update_key', + 'delete_key', + 'migrate_key', + 'get_metrics', + 'list_related_account_groups', + 'list_related_account_group_memberships', + 'search_related_account_group_memberships', + ) + 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_recaptcha_enterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecaptchaEnterpriseServiceTransport( + 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_recaptcha_enterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.RecaptchaEnterpriseServiceTransport() + adc.assert_called_once() + + +def test_recaptcha_enterprise_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) + RecaptchaEnterpriseServiceClient() + 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.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, + ], +) +def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, + transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, + ], +) +def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, grpc_helpers), + (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_recaptcha_enterprise_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( + "recaptchaenterprise.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="recaptchaenterprise.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_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 + ) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_recaptcha_enterprise_service_host_no_port(transport_name): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'recaptchaenterprise.googleapis.com:443' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_recaptcha_enterprise_service_host_with_port(transport_name): + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'recaptchaenterprise.googleapis.com:8000' + ) + +def test_recaptcha_enterprise_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecaptchaEnterpriseServiceGrpcTransport( + 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_recaptcha_enterprise_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( + 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.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) +def test_recaptcha_enterprise_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_assessment_path(): + project = "squid" + assessment = "clam" + expected = "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) + actual = RecaptchaEnterpriseServiceClient.assessment_path(project, assessment) + assert expected == actual + + +def test_parse_assessment_path(): + expected = { + "project": "whelk", + "assessment": "octopus", + } + path = RecaptchaEnterpriseServiceClient.assessment_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_assessment_path(path) + assert expected == actual + +def test_key_path(): + project = "oyster" + key = "nudibranch" + expected = "projects/{project}/keys/{key}".format(project=project, key=key, ) + actual = RecaptchaEnterpriseServiceClient.key_path(project, key) + assert expected == actual + + +def test_parse_key_path(): + expected = { + "project": "cuttlefish", + "key": "mussel", + } + path = RecaptchaEnterpriseServiceClient.key_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_key_path(path) + assert expected == actual + +def test_metrics_path(): + project = "winkle" + key = "nautilus" + expected = "projects/{project}/keys/{key}/metrics".format(project=project, key=key, ) + actual = RecaptchaEnterpriseServiceClient.metrics_path(project, key) + assert expected == actual + + +def test_parse_metrics_path(): + expected = { + "project": "scallop", + "key": "abalone", + } + path = RecaptchaEnterpriseServiceClient.metrics_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_metrics_path(path) + assert expected == actual + +def test_related_account_group_path(): + project = "squid" + relatedaccountgroup = "clam" + expected = "projects/{project}/relatedaccountgroups/{relatedaccountgroup}".format(project=project, relatedaccountgroup=relatedaccountgroup, ) + actual = RecaptchaEnterpriseServiceClient.related_account_group_path(project, relatedaccountgroup) + assert expected == actual + + +def test_parse_related_account_group_path(): + expected = { + "project": "whelk", + "relatedaccountgroup": "octopus", + } + path = RecaptchaEnterpriseServiceClient.related_account_group_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_related_account_group_path(path) + assert expected == actual + +def test_related_account_group_membership_path(): + project = "oyster" + relatedaccountgroup = "nudibranch" + membership = "cuttlefish" + expected = "projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}".format(project=project, relatedaccountgroup=relatedaccountgroup, membership=membership, ) + actual = RecaptchaEnterpriseServiceClient.related_account_group_membership_path(project, relatedaccountgroup, membership) + assert expected == actual + + +def test_parse_related_account_group_membership_path(): + expected = { + "project": "mussel", + "relatedaccountgroup": "winkle", + "membership": "nautilus", + } + path = RecaptchaEnterpriseServiceClient.related_account_group_membership_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_related_account_group_membership_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "scallop" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = RecaptchaEnterpriseServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "abalone", + } + path = RecaptchaEnterpriseServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "squid" + expected = "folders/{folder}".format(folder=folder, ) + actual = RecaptchaEnterpriseServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "clam", + } + path = RecaptchaEnterpriseServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "whelk" + expected = "organizations/{organization}".format(organization=organization, ) + actual = RecaptchaEnterpriseServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "octopus", + } + path = RecaptchaEnterpriseServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "oyster" + expected = "projects/{project}".format(project=project, ) + actual = RecaptchaEnterpriseServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nudibranch", + } + path = RecaptchaEnterpriseServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "cuttlefish" + location = "mussel" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = RecaptchaEnterpriseServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "winkle", + "location": "nautilus", + } + path = RecaptchaEnterpriseServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = RecaptchaEnterpriseServiceClient.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.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: + client = RecaptchaEnterpriseServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = RecaptchaEnterpriseServiceClient.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 = RecaptchaEnterpriseServiceAsyncClient( + 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 = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = RecaptchaEnterpriseServiceClient( + 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 = [ + 'grpc', + ] + for transport in transports: + client = RecaptchaEnterpriseServiceClient( + 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", [ + (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport), + (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport), +]) +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 57cafa28ccc747dc650053634692b3136580089a Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:06:14 +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 | 4 +- .../recaptcha_enterprise_service/client.py | 4 +- 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 -- owl-bot-staging/v1/docs/index.rst | 7 - .../recaptcha_enterprise_service.rst | 10 - .../docs/recaptchaenterprise_v1/services.rst | 6 - .../v1/docs/recaptchaenterprise_v1/types.rst | 6 - .../cloud/recaptchaenterprise/__init__.py | 111 - .../recaptchaenterprise/gapic_version.py | 16 - .../google/cloud/recaptchaenterprise/py.typed | 2 - .../cloud/recaptchaenterprise_v1/__init__.py | 112 - .../gapic_metadata.json | 153 - .../recaptchaenterprise_v1/gapic_version.py | 16 - .../cloud/recaptchaenterprise_v1/py.typed | 2 - .../services/__init__.py | 15 - .../recaptcha_enterprise_service/__init__.py | 22 - .../async_client.py | 1623 ------ .../recaptcha_enterprise_service/client.py | 1862 ------ .../recaptcha_enterprise_service/pagers.py | 502 -- .../transports/__init__.py | 33 - .../transports/base.py | 317 -- .../transports/grpc.py | 592 -- .../transports/grpc_asyncio.py | 591 -- .../recaptchaenterprise_v1/types/__init__.py | 104 - .../types/recaptchaenterprise.py | 2232 -------- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 184 - ...prise_service_annotate_assessment_async.py | 52 - ...rprise_service_annotate_assessment_sync.py | 52 - ...erprise_service_create_assessment_async.py | 52 - ...terprise_service_create_assessment_sync.py | 52 - ...cha_enterprise_service_create_key_async.py | 56 - ...tcha_enterprise_service_create_key_sync.py | 56 - ...cha_enterprise_service_delete_key_async.py | 50 - ...tcha_enterprise_service_delete_key_sync.py | 50 - ...aptcha_enterprise_service_get_key_async.py | 52 - ...captcha_enterprise_service_get_key_sync.py | 52 - ...ha_enterprise_service_get_metrics_async.py | 52 - ...cha_enterprise_service_get_metrics_sync.py | 52 - ...tcha_enterprise_service_list_keys_async.py | 53 - ...ptcha_enterprise_service_list_keys_sync.py | 53 - ...related_account_group_memberships_async.py | 53 - ..._related_account_group_memberships_sync.py | 53 - ...rvice_list_related_account_groups_async.py | 53 - ...ervice_list_related_account_groups_sync.py | 53 - ...ha_enterprise_service_migrate_key_async.py | 52 - ...cha_enterprise_service_migrate_key_sync.py | 52 - ...ervice_retrieve_legacy_secret_key_async.py | 52 - ...service_retrieve_legacy_secret_key_sync.py | 52 - ...related_account_group_memberships_async.py | 53 - ..._related_account_group_memberships_sync.py | 53 - ...cha_enterprise_service_update_key_async.py | 55 - ...tcha_enterprise_service_update_key_sync.py | 55 - ...a_google.cloud.recaptchaenterprise.v1.json | 2134 ------- .../fixup_recaptchaenterprise_v1_keywords.py | 188 - 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/recaptchaenterprise_v1/__init__.py | 16 - .../test_recaptcha_enterprise_service.py | 4996 ----------------- 71 files changed, 4 insertions(+), 17879 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/index.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.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/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py delete mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json delete mode 100644 owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_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/recaptchaenterprise_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py diff --git a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py index bc91815..30ec9c7 100644 --- a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py +++ b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py @@ -1597,8 +1597,8 @@ async def sample_search_related_account_group_memberships(): Args: request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]]): - The request object. The request message to search - related account group memberships. + The request object. The request message to search related + account group memberships. project (:class:`str`): Required. The name of the project to search related account group memberships diff --git a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py index 03ed38b..77c09e0 100644 --- a/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py +++ b/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py @@ -1881,8 +1881,8 @@ def sample_search_related_account_group_memberships(): Args: request (Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]): - The request object. The request message to search - related account group memberships. + The request object. The request message to search related + account group memberships. project (str): Required. The name of the project to search related account group memberships diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index a3d09d1..0000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/recaptchaenterprise/__init__.py - google/cloud/recaptchaenterprise/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 2ebaff4..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/recaptchaenterprise *.py -recursive-include google/cloud/recaptchaenterprise_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index dd39e48..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Recaptchaenterprise 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 Recaptchaenterprise 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 6dba3e7..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-recaptcha-enterprise 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-recaptcha-enterprise" -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-recaptcha-enterprise-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-recaptcha-enterprise.tex", - u"google-cloud-recaptcha-enterprise 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-recaptcha-enterprise", - u"Google Cloud Recaptchaenterprise 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-recaptcha-enterprise", - u"google-cloud-recaptcha-enterprise Documentation", - author, - "google-cloud-recaptcha-enterprise", - "GAPIC library for Google Cloud Recaptchaenterprise API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index 35c60ea..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - recaptchaenterprise_v1/services - recaptchaenterprise_v1/types diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst deleted file mode 100644 index 5031186..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/recaptcha_enterprise_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -RecaptchaEnterpriseService --------------------------------------------- - -.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service - :members: - :inherited-members: - -.. automodule:: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst deleted file mode 100644 index 4211502..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Recaptchaenterprise v1 API -==================================================== -.. toctree:: - :maxdepth: 2 - - recaptcha_enterprise_service diff --git a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst b/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst deleted file mode 100644 index 788d8d5..0000000 --- a/owl-bot-staging/v1/docs/recaptchaenterprise_v1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Recaptchaenterprise v1 API -================================================= - -.. automodule:: google.cloud.recaptchaenterprise_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py deleted file mode 100644 index 0d1d2de..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/__init__.py +++ /dev/null @@ -1,111 +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.recaptchaenterprise import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.client import RecaptchaEnterpriseServiceClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.async_client import RecaptchaEnterpriseServiceAsyncClient - -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AccountDefenderAssessment -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AccountVerificationInfo -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AndroidKeySettings -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import AnnotateAssessmentResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Assessment -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ChallengeMetrics -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateAssessmentRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import CreateKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import DeleteKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import EndpointVerificationInfo -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Event -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import FraudPreventionAssessment -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import GetMetricsRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import IOSKeySettings -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Key -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListKeysResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupMembershipsRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupMembershipsResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupsRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ListRelatedAccountGroupsResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import Metrics -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import MigrateKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import PrivatePasswordLeakVerification -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RelatedAccountGroup -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RelatedAccountGroupMembership -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RetrieveLegacySecretKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RetrieveLegacySecretKeyResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import RiskAnalysis -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ScoreDistribution -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import ScoreMetrics -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsResponse -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TestingOptions -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TokenProperties -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TransactionData -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import TransactionEvent -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import UpdateKeyRequest -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WafSettings -from google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise import WebKeySettings - -__all__ = ('RecaptchaEnterpriseServiceClient', - 'RecaptchaEnterpriseServiceAsyncClient', - 'AccountDefenderAssessment', - 'AccountVerificationInfo', - 'AndroidKeySettings', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'Assessment', - 'ChallengeMetrics', - 'CreateAssessmentRequest', - 'CreateKeyRequest', - 'DeleteKeyRequest', - 'EndpointVerificationInfo', - 'Event', - 'FraudPreventionAssessment', - 'GetKeyRequest', - 'GetMetricsRequest', - 'IOSKeySettings', - 'Key', - 'ListKeysRequest', - 'ListKeysResponse', - 'ListRelatedAccountGroupMembershipsRequest', - 'ListRelatedAccountGroupMembershipsResponse', - 'ListRelatedAccountGroupsRequest', - 'ListRelatedAccountGroupsResponse', - 'Metrics', - 'MigrateKeyRequest', - 'PrivatePasswordLeakVerification', - 'RelatedAccountGroup', - 'RelatedAccountGroupMembership', - 'RetrieveLegacySecretKeyRequest', - 'RetrieveLegacySecretKeyResponse', - 'RiskAnalysis', - 'ScoreDistribution', - 'ScoreMetrics', - 'SearchRelatedAccountGroupMembershipsRequest', - 'SearchRelatedAccountGroupMembershipsResponse', - 'TestingOptions', - 'TokenProperties', - 'TransactionData', - 'TransactionEvent', - 'UpdateKeyRequest', - 'WafSettings', - 'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/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/recaptchaenterprise/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed deleted file mode 100644 index 2c6a51a..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recaptcha-enterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py deleted file mode 100644 index 056a970..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/__init__.py +++ /dev/null @@ -1,112 +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.recaptchaenterprise_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient -from .services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient - -from .types.recaptchaenterprise import AccountDefenderAssessment -from .types.recaptchaenterprise import AccountVerificationInfo -from .types.recaptchaenterprise import AndroidKeySettings -from .types.recaptchaenterprise import AnnotateAssessmentRequest -from .types.recaptchaenterprise import AnnotateAssessmentResponse -from .types.recaptchaenterprise import Assessment -from .types.recaptchaenterprise import ChallengeMetrics -from .types.recaptchaenterprise import CreateAssessmentRequest -from .types.recaptchaenterprise import CreateKeyRequest -from .types.recaptchaenterprise import DeleteKeyRequest -from .types.recaptchaenterprise import EndpointVerificationInfo -from .types.recaptchaenterprise import Event -from .types.recaptchaenterprise import FraudPreventionAssessment -from .types.recaptchaenterprise import GetKeyRequest -from .types.recaptchaenterprise import GetMetricsRequest -from .types.recaptchaenterprise import IOSKeySettings -from .types.recaptchaenterprise import Key -from .types.recaptchaenterprise import ListKeysRequest -from .types.recaptchaenterprise import ListKeysResponse -from .types.recaptchaenterprise import ListRelatedAccountGroupMembershipsRequest -from .types.recaptchaenterprise import ListRelatedAccountGroupMembershipsResponse -from .types.recaptchaenterprise import ListRelatedAccountGroupsRequest -from .types.recaptchaenterprise import ListRelatedAccountGroupsResponse -from .types.recaptchaenterprise import Metrics -from .types.recaptchaenterprise import MigrateKeyRequest -from .types.recaptchaenterprise import PrivatePasswordLeakVerification -from .types.recaptchaenterprise import RelatedAccountGroup -from .types.recaptchaenterprise import RelatedAccountGroupMembership -from .types.recaptchaenterprise import RetrieveLegacySecretKeyRequest -from .types.recaptchaenterprise import RetrieveLegacySecretKeyResponse -from .types.recaptchaenterprise import RiskAnalysis -from .types.recaptchaenterprise import ScoreDistribution -from .types.recaptchaenterprise import ScoreMetrics -from .types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsRequest -from .types.recaptchaenterprise import SearchRelatedAccountGroupMembershipsResponse -from .types.recaptchaenterprise import TestingOptions -from .types.recaptchaenterprise import TokenProperties -from .types.recaptchaenterprise import TransactionData -from .types.recaptchaenterprise import TransactionEvent -from .types.recaptchaenterprise import UpdateKeyRequest -from .types.recaptchaenterprise import WafSettings -from .types.recaptchaenterprise import WebKeySettings - -__all__ = ( - 'RecaptchaEnterpriseServiceAsyncClient', -'AccountDefenderAssessment', -'AccountVerificationInfo', -'AndroidKeySettings', -'AnnotateAssessmentRequest', -'AnnotateAssessmentResponse', -'Assessment', -'ChallengeMetrics', -'CreateAssessmentRequest', -'CreateKeyRequest', -'DeleteKeyRequest', -'EndpointVerificationInfo', -'Event', -'FraudPreventionAssessment', -'GetKeyRequest', -'GetMetricsRequest', -'IOSKeySettings', -'Key', -'ListKeysRequest', -'ListKeysResponse', -'ListRelatedAccountGroupMembershipsRequest', -'ListRelatedAccountGroupMembershipsResponse', -'ListRelatedAccountGroupsRequest', -'ListRelatedAccountGroupsResponse', -'Metrics', -'MigrateKeyRequest', -'PrivatePasswordLeakVerification', -'RecaptchaEnterpriseServiceClient', -'RelatedAccountGroup', -'RelatedAccountGroupMembership', -'RetrieveLegacySecretKeyRequest', -'RetrieveLegacySecretKeyResponse', -'RiskAnalysis', -'ScoreDistribution', -'ScoreMetrics', -'SearchRelatedAccountGroupMembershipsRequest', -'SearchRelatedAccountGroupMembershipsResponse', -'TestingOptions', -'TokenProperties', -'TransactionData', -'TransactionEvent', -'UpdateKeyRequest', -'WafSettings', -'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json deleted file mode 100644 index c44d903..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_metadata.json +++ /dev/null @@ -1,153 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.recaptchaenterprise_v1", - "protoPackage": "google.cloud.recaptchaenterprise.v1", - "schema": "1.0", - "services": { - "RecaptchaEnterpriseService": { - "clients": { - "grpc": { - "libraryClient": "RecaptchaEnterpriseServiceClient", - "rpcs": { - "AnnotateAssessment": { - "methods": [ - "annotate_assessment" - ] - }, - "CreateAssessment": { - "methods": [ - "create_assessment" - ] - }, - "CreateKey": { - "methods": [ - "create_key" - ] - }, - "DeleteKey": { - "methods": [ - "delete_key" - ] - }, - "GetKey": { - "methods": [ - "get_key" - ] - }, - "GetMetrics": { - "methods": [ - "get_metrics" - ] - }, - "ListKeys": { - "methods": [ - "list_keys" - ] - }, - "ListRelatedAccountGroupMemberships": { - "methods": [ - "list_related_account_group_memberships" - ] - }, - "ListRelatedAccountGroups": { - "methods": [ - "list_related_account_groups" - ] - }, - "MigrateKey": { - "methods": [ - "migrate_key" - ] - }, - "RetrieveLegacySecretKey": { - "methods": [ - "retrieve_legacy_secret_key" - ] - }, - "SearchRelatedAccountGroupMemberships": { - "methods": [ - "search_related_account_group_memberships" - ] - }, - "UpdateKey": { - "methods": [ - "update_key" - ] - } - } - }, - "grpc-async": { - "libraryClient": "RecaptchaEnterpriseServiceAsyncClient", - "rpcs": { - "AnnotateAssessment": { - "methods": [ - "annotate_assessment" - ] - }, - "CreateAssessment": { - "methods": [ - "create_assessment" - ] - }, - "CreateKey": { - "methods": [ - "create_key" - ] - }, - "DeleteKey": { - "methods": [ - "delete_key" - ] - }, - "GetKey": { - "methods": [ - "get_key" - ] - }, - "GetMetrics": { - "methods": [ - "get_metrics" - ] - }, - "ListKeys": { - "methods": [ - "list_keys" - ] - }, - "ListRelatedAccountGroupMemberships": { - "methods": [ - "list_related_account_group_memberships" - ] - }, - "ListRelatedAccountGroups": { - "methods": [ - "list_related_account_groups" - ] - }, - "MigrateKey": { - "methods": [ - "migrate_key" - ] - }, - "RetrieveLegacySecretKey": { - "methods": [ - "retrieve_legacy_secret_key" - ] - }, - "SearchRelatedAccountGroupMemberships": { - "methods": [ - "search_related_account_group_memberships" - ] - }, - "UpdateKey": { - "methods": [ - "update_key" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_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/recaptchaenterprise_v1/py.typed b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed deleted file mode 100644 index 2c6a51a..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-recaptcha-enterprise package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/__init__.py deleted file mode 100644 index e8e1c38..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_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/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/__init__.py deleted file mode 100644 index d017ca6..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_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 RecaptchaEnterpriseServiceClient -from .async_client import RecaptchaEnterpriseServiceAsyncClient - -__all__ = ( - 'RecaptchaEnterpriseServiceClient', - 'RecaptchaEnterpriseServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py deleted file mode 100644 index 316d8f2..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py +++ /dev/null @@ -1,1623 +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.recaptchaenterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport -from .client import RecaptchaEnterpriseServiceClient - - -class RecaptchaEnterpriseServiceAsyncClient: - """Service to determine the likelihood an event is legitimate.""" - - _client: RecaptchaEnterpriseServiceClient - - DEFAULT_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = RecaptchaEnterpriseServiceClient.DEFAULT_MTLS_ENDPOINT - - assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.assessment_path) - parse_assessment_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_assessment_path) - key_path = staticmethod(RecaptchaEnterpriseServiceClient.key_path) - parse_key_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_key_path) - metrics_path = staticmethod(RecaptchaEnterpriseServiceClient.metrics_path) - parse_metrics_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_metrics_path) - related_account_group_path = staticmethod(RecaptchaEnterpriseServiceClient.related_account_group_path) - parse_related_account_group_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_related_account_group_path) - related_account_group_membership_path = staticmethod(RecaptchaEnterpriseServiceClient.related_account_group_membership_path) - parse_related_account_group_membership_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_related_account_group_membership_path) - common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_organization_path) - common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.common_project_path) - parse_common_project_path = staticmethod(RecaptchaEnterpriseServiceClient.parse_common_project_path) - common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.common_location_path) - parse_common_location_path = staticmethod(RecaptchaEnterpriseServiceClient.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: - RecaptchaEnterpriseServiceAsyncClient: The constructed client. - """ - return RecaptchaEnterpriseServiceClient.from_service_account_info.__func__(RecaptchaEnterpriseServiceAsyncClient, 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: - RecaptchaEnterpriseServiceAsyncClient: The constructed client. - """ - return RecaptchaEnterpriseServiceClient.from_service_account_file.__func__(RecaptchaEnterpriseServiceAsyncClient, 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 RecaptchaEnterpriseServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> RecaptchaEnterpriseServiceTransport: - """Returns the transport used by the client instance. - - Returns: - RecaptchaEnterpriseServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(RecaptchaEnterpriseServiceClient).get_transport_class, type(RecaptchaEnterpriseServiceClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, RecaptchaEnterpriseServiceTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recaptcha enterprise 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, ~.RecaptchaEnterpriseServiceTransport]): 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 = RecaptchaEnterpriseServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_assessment(self, - request: Optional[Union[recaptchaenterprise.CreateAssessmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - assessment: Optional[recaptchaenterprise.Assessment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Assessment: - r"""Creates an Assessment of the likelihood an event is - legitimate. - - .. 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 recaptchaenterprise_v1 - - async def sample_create_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.CreateAssessmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_assessment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]]): - The request object. The create assessment request - message. - parent (:class:`str`): - Required. The name of the project in - which the assessment will be created, in - the format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assessment (:class:`google.cloud.recaptchaenterprise_v1.types.Assessment`): - Required. The assessment details. - This corresponds to the ``assessment`` 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.recaptchaenterprise_v1.types.Assessment: - A reCAPTCHA Enterprise assessment - resource. - - """ - # 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, assessment]) - 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 = recaptchaenterprise.CreateAssessmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assessment is not None: - request.assessment = assessment - - # 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_assessment, - default_timeout=600.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 annotate_assessment(self, - request: Optional[Union[recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, - *, - name: Optional[str] = None, - annotation: Optional[recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.AnnotateAssessmentResponse: - r"""Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fraudulent. - - .. 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 recaptchaenterprise_v1 - - async def sample_annotate_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.AnnotateAssessmentRequest( - name="name_value", - ) - - # Make the request - response = await client.annotate_assessment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]]): - The request object. The request message to annotate an - Assessment. - name (:class:`str`): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`): - Optional. The annotation that will be - assigned to the Event. This field can be - left empty to provide reasons that apply - to an event without concluding whether - the event is legitimate or fraudulent. - - This corresponds to the ``annotation`` 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.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: - Empty response for - AnnotateAssessment. - - """ - # 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, annotation]) - 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 = recaptchaenterprise.AnnotateAssessmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if annotation is not None: - request.annotation = annotation - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.annotate_assessment, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_key(self, - request: Optional[Union[recaptchaenterprise.CreateKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - key: Optional[recaptchaenterprise.Key] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Creates a new reCAPTCHA Enterprise key. - - .. 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 recaptchaenterprise_v1 - - async def sample_create_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.CreateKeyRequest( - parent="parent_value", - key=key, - ) - - # Make the request - response = await client.create_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]]): - The request object. The create key request message. - parent (:class:`str`): - Required. The name of the project in - which the key will be created, in the - format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - key (:class:`google.cloud.recaptchaenterprise_v1.types.Key`): - Required. Information to create a - reCAPTCHA Enterprise key. - - This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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, key]) - 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 = recaptchaenterprise.CreateKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if key is not None: - request.key = key - - # 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_key, - default_timeout=600.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 list_keys(self, - request: Optional[Union[recaptchaenterprise.ListKeysRequest, 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.ListKeysAsyncPager: - r"""Returns the list of all keys that belong to a - project. - - .. 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 recaptchaenterprise_v1 - - async def sample_list_keys(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListKeysRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_keys(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]]): - The request object. The list keys request message. - parent (:class:`str`): - Required. The name of the project - that contains the keys that will be - listed, in the format - "projects/{project}". - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager: - Response to request to list keys in a - project. - 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 = recaptchaenterprise.ListKeysRequest(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_keys, - default_timeout=600.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.ListKeysAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def retrieve_legacy_secret_key(self, - request: Optional[Union[recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, - *, - key: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.RetrieveLegacySecretKeyResponse: - r"""Returns the secret key related to the specified - public key. You must use the legacy secret key only in a - 3rd party integration with legacy reCAPTCHA. - - .. 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 recaptchaenterprise_v1 - - async def sample_retrieve_legacy_secret_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( - key="key_value", - ) - - # Make the request - response = await client.retrieve_legacy_secret_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]]): - The request object. The retrieve legacy secret key - request message. - key (:class:`str`): - Required. The public key name linked - to the requested secret key in the - format "projects/{project}/keys/{key}". - - This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse: - Secret key is used only in legacy - reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - - """ - # 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([key]) - 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if key is not None: - request.key = key - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.retrieve_legacy_secret_key, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("key", request.key), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_key(self, - request: Optional[Union[recaptchaenterprise.GetKeyRequest, 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]] = (), - ) -> recaptchaenterprise.Key: - r"""Returns the specified key. - - .. 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 recaptchaenterprise_v1 - - async def sample_get_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.get_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]]): - The request object. The get key request message. - name (:class:`str`): - Required. The name of the requested - key, in the format - "projects/{project}/keys/{key}". - - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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 = recaptchaenterprise.GetKeyRequest(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_key, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_key(self, - request: Optional[Union[recaptchaenterprise.UpdateKeyRequest, dict]] = None, - *, - key: Optional[recaptchaenterprise.Key] = 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]] = (), - ) -> recaptchaenterprise.Key: - r"""Updates the specified key. - - .. 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 recaptchaenterprise_v1 - - async def sample_update_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.UpdateKeyRequest( - key=key, - ) - - # Make the request - response = await client.update_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]]): - The request object. The update key request message. - key (:class:`google.cloud.recaptchaenterprise_v1.types.Key`): - Required. The key to update. - This corresponds to the ``key`` 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 mask to control which - fields of the key get updated. If the - mask is not present, all fields will be - updated. - - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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([key, 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 = recaptchaenterprise.UpdateKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if key is not None: - request.key = key - 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_key, - default_timeout=600.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(( - ("key.name", request.key.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_key(self, - request: Optional[Union[recaptchaenterprise.DeleteKeyRequest, 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 the specified key. - - .. 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 recaptchaenterprise_v1 - - async def sample_delete_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.DeleteKeyRequest( - name="name_value", - ) - - # Make the request - await client.delete_key(request=request) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]]): - The request object. The delete key request message. - name (:class:`str`): - Required. The name of the key to be - deleted, in the format - "projects/{project}/keys/{key}". - - 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 = recaptchaenterprise.DeleteKeyRequest(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_key, - default_timeout=600.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 migrate_key(self, - request: Optional[Union[recaptchaenterprise.MigrateKeyRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Migrates an existing key from reCAPTCHA to reCAPTCHA - Enterprise. Once a key is migrated, it can be used from - either product. SiteVerify requests are billed as - CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Site Key, and - your user must have the reCAPTCHA Enterprise Admin IAM - role in the destination project. - - .. 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 recaptchaenterprise_v1 - - async def sample_migrate_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.MigrateKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.migrate_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]]): - The request object. The migrate key request message. - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - request = recaptchaenterprise.MigrateKeyRequest(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.migrate_key, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_metrics(self, - request: Optional[Union[recaptchaenterprise.GetMetricsRequest, 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]] = (), - ) -> recaptchaenterprise.Metrics: - r"""Get some aggregated metrics for a Key. This data can - be used to build dashboards. - - .. 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 recaptchaenterprise_v1 - - async def sample_get_metrics(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetMetricsRequest( - name="name_value", - ) - - # Make the request - response = await client.get_metrics(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]]): - The request object. The get metrics request message. - name (:class:`str`): - Required. The name of the requested - metrics, in the format - "projects/{project}/keys/{key}/metrics". - - 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.recaptchaenterprise_v1.types.Metrics: - Metrics for a single Key. - """ - # 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 = recaptchaenterprise.GetMetricsRequest(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_metrics, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_related_account_groups(self, - request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupsRequest, 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.ListRelatedAccountGroupsAsyncPager: - r"""List groups of related accounts. - - .. 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 recaptchaenterprise_v1 - - async def sample_list_related_account_groups(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_groups(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]]): - The request object. The request message to list related - account groups. - parent (:class:`str`): - Required. The name of the project to - list related account groups from, in the - format "projects/{project}". - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager: - The response to a ListRelatedAccountGroups call. - - 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(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_related_account_groups, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListRelatedAccountGroupsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_related_account_group_memberships(self, - request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, 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.ListRelatedAccountGroupMembershipsAsyncPager: - r"""Get memberships in a group of related accounts. - - .. 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 recaptchaenterprise_v1 - - async def sample_list_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_group_memberships(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]]): - The request object. The request message to list - memberships in a related account group. - parent (:class:`str`): - Required. The resource name for the related account - group in the format - ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager: - The response to a ListRelatedAccountGroupMemberships - call. - - 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(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_related_account_group_memberships, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListRelatedAccountGroupMembershipsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def search_related_account_group_memberships(self, - request: Optional[Union[recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, - *, - project: Optional[str] = None, - hashed_account_id: Optional[bytes] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchRelatedAccountGroupMembershipsAsyncPager: - r"""Search group memberships related to a given account. - - .. 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 recaptchaenterprise_v1 - - async def sample_search_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( - project="project_value", - ) - - # Make the request - page_result = client.search_related_account_group_memberships(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]]): - The request object. The request message to search related - account group memberships. - project (:class:`str`): - Required. The name of the project to - search related account group memberships - from. Specify the project name in the - following format: "projects/{project}". - - This corresponds to the ``project`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - hashed_account_id (:class:`bytes`): - Optional. The unique stable hashed user identifier we - should search connections to. The identifier should - correspond to a ``hashed_account_id`` provided in a - previous ``CreateAssessment`` or ``AnnotateAssessment`` - call. - - This corresponds to the ``hashed_account_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager: - The response to a SearchRelatedAccountGroupMemberships - call. - - 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([project, hashed_account_id]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if project is not None: - request.project = project - if hashed_account_id is not None: - request.hashed_account_id = hashed_account_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.search_related_account_group_memberships, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("project", request.project), - )), - ) - - # 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.SearchRelatedAccountGroupMembershipsAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "RecaptchaEnterpriseServiceAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py deleted file mode 100644 index 3460a98..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py +++ /dev/null @@ -1,1862 +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.recaptchaenterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import RecaptchaEnterpriseServiceGrpcTransport -from .transports.grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - -class RecaptchaEnterpriseServiceClientMeta(type): - """Metaclass for the RecaptchaEnterpriseService 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[RecaptchaEnterpriseServiceTransport]] - _transport_registry["grpc"] = RecaptchaEnterpriseServiceGrpcTransport - _transport_registry["grpc_asyncio"] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[RecaptchaEnterpriseServiceTransport]: - """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 RecaptchaEnterpriseServiceClient(metaclass=RecaptchaEnterpriseServiceClientMeta): - """Service to determine the likelihood an event is legitimate.""" - - @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 = "recaptchaenterprise.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: - RecaptchaEnterpriseServiceClient: 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: - RecaptchaEnterpriseServiceClient: 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) -> RecaptchaEnterpriseServiceTransport: - """Returns the transport used by the client instance. - - Returns: - RecaptchaEnterpriseServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def assessment_path(project: str,assessment: str,) -> str: - """Returns a fully-qualified assessment string.""" - return "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) - - @staticmethod - def parse_assessment_path(path: str) -> Dict[str,str]: - """Parses a assessment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/assessments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def key_path(project: str,key: str,) -> str: - """Returns a fully-qualified key string.""" - return "projects/{project}/keys/{key}".format(project=project, key=key, ) - - @staticmethod - def parse_key_path(path: str) -> Dict[str,str]: - """Parses a key path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def metrics_path(project: str,key: str,) -> str: - """Returns a fully-qualified metrics string.""" - return "projects/{project}/keys/{key}/metrics".format(project=project, key=key, ) - - @staticmethod - def parse_metrics_path(path: str) -> Dict[str,str]: - """Parses a metrics path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/keys/(?P.+?)/metrics$", path) - return m.groupdict() if m else {} - - @staticmethod - def related_account_group_path(project: str,relatedaccountgroup: str,) -> str: - """Returns a fully-qualified related_account_group string.""" - return "projects/{project}/relatedaccountgroups/{relatedaccountgroup}".format(project=project, relatedaccountgroup=relatedaccountgroup, ) - - @staticmethod - def parse_related_account_group_path(path: str) -> Dict[str,str]: - """Parses a related_account_group path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/relatedaccountgroups/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def related_account_group_membership_path(project: str,relatedaccountgroup: str,membership: str,) -> str: - """Returns a fully-qualified related_account_group_membership string.""" - return "projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}".format(project=project, relatedaccountgroup=relatedaccountgroup, membership=membership, ) - - @staticmethod - def parse_related_account_group_membership_path(path: str) -> Dict[str,str]: - """Parses a related_account_group_membership path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/relatedaccountgroups/(?P.+?)/memberships/(?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, RecaptchaEnterpriseServiceTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the recaptcha enterprise 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, RecaptchaEnterpriseServiceTransport]): 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, RecaptchaEnterpriseServiceTransport): - # transport is a RecaptchaEnterpriseServiceTransport 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_assessment(self, - request: Optional[Union[recaptchaenterprise.CreateAssessmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - assessment: Optional[recaptchaenterprise.Assessment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Assessment: - r"""Creates an Assessment of the likelihood an event is - legitimate. - - .. 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 recaptchaenterprise_v1 - - def sample_create_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.CreateAssessmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_assessment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]): - The request object. The create assessment request - message. - parent (str): - Required. The name of the project in - which the assessment will be created, in - the format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): - Required. The assessment details. - This corresponds to the ``assessment`` 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.recaptchaenterprise_v1.types.Assessment: - A reCAPTCHA Enterprise assessment - resource. - - """ - # 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, assessment]) - 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 recaptchaenterprise.CreateAssessmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.CreateAssessmentRequest): - request = recaptchaenterprise.CreateAssessmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assessment is not None: - request.assessment = assessment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_assessment] - - # 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 annotate_assessment(self, - request: Optional[Union[recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, - *, - name: Optional[str] = None, - annotation: Optional[recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.AnnotateAssessmentResponse: - r"""Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fraudulent. - - .. 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 recaptchaenterprise_v1 - - def sample_annotate_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.AnnotateAssessmentRequest( - name="name_value", - ) - - # Make the request - response = client.annotate_assessment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]): - The request object. The request message to annotate an - Assessment. - name (str): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): - Optional. The annotation that will be - assigned to the Event. This field can be - left empty to provide reasons that apply - to an event without concluding whether - the event is legitimate or fraudulent. - - This corresponds to the ``annotation`` 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.recaptchaenterprise_v1.types.AnnotateAssessmentResponse: - Empty response for - AnnotateAssessment. - - """ - # 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, annotation]) - 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 recaptchaenterprise.AnnotateAssessmentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.AnnotateAssessmentRequest): - request = recaptchaenterprise.AnnotateAssessmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if annotation is not None: - request.annotation = annotation - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.annotate_assessment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_key(self, - request: Optional[Union[recaptchaenterprise.CreateKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - key: Optional[recaptchaenterprise.Key] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Creates a new reCAPTCHA Enterprise key. - - .. 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 recaptchaenterprise_v1 - - def sample_create_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.CreateKeyRequest( - parent="parent_value", - key=key, - ) - - # Make the request - response = client.create_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]): - The request object. The create key request message. - parent (str): - Required. The name of the project in - which the key will be created, in the - format "projects/{project}". - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. Information to create a - reCAPTCHA Enterprise key. - - This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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, key]) - 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 recaptchaenterprise.CreateKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.CreateKeyRequest): - request = recaptchaenterprise.CreateKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if key is not None: - request.key = key - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_key] - - # 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 list_keys(self, - request: Optional[Union[recaptchaenterprise.ListKeysRequest, 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.ListKeysPager: - r"""Returns the list of all keys that belong to a - project. - - .. 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 recaptchaenterprise_v1 - - def sample_list_keys(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListKeysRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_keys(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]): - The request object. The list keys request message. - parent (str): - Required. The name of the project - that contains the keys that will be - listed, in the format - "projects/{project}". - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager: - Response to request to list keys in a - project. - 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 recaptchaenterprise.ListKeysRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.ListKeysRequest): - request = recaptchaenterprise.ListKeysRequest(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_keys] - - # 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.ListKeysPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def retrieve_legacy_secret_key(self, - request: Optional[Union[recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, - *, - key: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.RetrieveLegacySecretKeyResponse: - r"""Returns the secret key related to the specified - public key. You must use the legacy secret key only in a - 3rd party integration with legacy reCAPTCHA. - - .. 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 recaptchaenterprise_v1 - - def sample_retrieve_legacy_secret_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( - key="key_value", - ) - - # Make the request - response = client.retrieve_legacy_secret_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]): - The request object. The retrieve legacy secret key - request message. - key (str): - Required. The public key name linked - to the requested secret key in the - format "projects/{project}/keys/{key}". - - This corresponds to the ``key`` 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.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse: - Secret key is used only in legacy - reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - - """ - # 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([key]) - 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 recaptchaenterprise.RetrieveLegacySecretKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.RetrieveLegacySecretKeyRequest): - request = recaptchaenterprise.RetrieveLegacySecretKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if key is not None: - request.key = key - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.retrieve_legacy_secret_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("key", request.key), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_key(self, - request: Optional[Union[recaptchaenterprise.GetKeyRequest, 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]] = (), - ) -> recaptchaenterprise.Key: - r"""Returns the specified key. - - .. 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 recaptchaenterprise_v1 - - def sample_get_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetKeyRequest( - name="name_value", - ) - - # Make the request - response = client.get_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]): - The request object. The get key request message. - name (str): - Required. The name of the requested - key, in the format - "projects/{project}/keys/{key}". - - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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 recaptchaenterprise.GetKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.GetKeyRequest): - request = recaptchaenterprise.GetKeyRequest(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_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_key(self, - request: Optional[Union[recaptchaenterprise.UpdateKeyRequest, dict]] = None, - *, - key: Optional[recaptchaenterprise.Key] = 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]] = (), - ) -> recaptchaenterprise.Key: - r"""Updates the specified key. - - .. 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 recaptchaenterprise_v1 - - def sample_update_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.UpdateKeyRequest( - key=key, - ) - - # Make the request - response = client.update_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]): - The request object. The update key request message. - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. The key to update. - This corresponds to the ``key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. The mask to control which - fields of the key get updated. If the - mask is not present, all fields will be - updated. - - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # 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([key, 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 recaptchaenterprise.UpdateKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.UpdateKeyRequest): - request = recaptchaenterprise.UpdateKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if key is not None: - request.key = key - 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_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("key.name", request.key.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_key(self, - request: Optional[Union[recaptchaenterprise.DeleteKeyRequest, 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 the specified key. - - .. 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 recaptchaenterprise_v1 - - def sample_delete_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.DeleteKeyRequest( - name="name_value", - ) - - # Make the request - client.delete_key(request=request) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]): - The request object. The delete key request message. - name (str): - Required. The name of the key to be - deleted, in the format - "projects/{project}/keys/{key}". - - 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 recaptchaenterprise.DeleteKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.DeleteKeyRequest): - request = recaptchaenterprise.DeleteKeyRequest(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_key] - - # 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 migrate_key(self, - request: Optional[Union[recaptchaenterprise.MigrateKeyRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> recaptchaenterprise.Key: - r"""Migrates an existing key from reCAPTCHA to reCAPTCHA - Enterprise. Once a key is migrated, it can be used from - either product. SiteVerify requests are billed as - CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Site Key, and - your user must have the reCAPTCHA Enterprise Admin IAM - role in the destination project. - - .. 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 recaptchaenterprise_v1 - - def sample_migrate_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.MigrateKeyRequest( - name="name_value", - ) - - # Make the request - response = client.migrate_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]): - The request object. The migrate key request message. - 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.recaptchaenterprise_v1.types.Key: - A key used to identify and configure - applications (web and/or mobile) that - use reCAPTCHA Enterprise. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.MigrateKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.MigrateKeyRequest): - request = recaptchaenterprise.MigrateKeyRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.migrate_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_metrics(self, - request: Optional[Union[recaptchaenterprise.GetMetricsRequest, 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]] = (), - ) -> recaptchaenterprise.Metrics: - r"""Get some aggregated metrics for a Key. This data can - be used to build dashboards. - - .. 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 recaptchaenterprise_v1 - - def sample_get_metrics(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetMetricsRequest( - name="name_value", - ) - - # Make the request - response = client.get_metrics(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]): - The request object. The get metrics request message. - name (str): - Required. The name of the requested - metrics, in the format - "projects/{project}/keys/{key}/metrics". - - 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.recaptchaenterprise_v1.types.Metrics: - Metrics for a single Key. - """ - # 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 recaptchaenterprise.GetMetricsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.GetMetricsRequest): - request = recaptchaenterprise.GetMetricsRequest(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_metrics] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_related_account_groups(self, - request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupsRequest, 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.ListRelatedAccountGroupsPager: - r"""List groups of related accounts. - - .. 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 recaptchaenterprise_v1 - - def sample_list_related_account_groups(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_groups(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]): - The request object. The request message to list related - account groups. - parent (str): - Required. The name of the project to - list related account groups from, in the - format "projects/{project}". - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager: - The response to a ListRelatedAccountGroups call. - - 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 recaptchaenterprise.ListRelatedAccountGroupsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.ListRelatedAccountGroupsRequest): - request = recaptchaenterprise.ListRelatedAccountGroupsRequest(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_related_account_groups] - - # 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.ListRelatedAccountGroupsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_related_account_group_memberships(self, - request: Optional[Union[recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, 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.ListRelatedAccountGroupMembershipsPager: - r"""Get memberships in a group of related accounts. - - .. 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 recaptchaenterprise_v1 - - def sample_list_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_group_memberships(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]): - The request object. The request message to list - memberships in a related account group. - parent (str): - Required. The resource name for the related account - group in the format - ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. - - 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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager: - The response to a ListRelatedAccountGroupMemberships - call. - - 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 recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest): - request = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(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_related_account_group_memberships] - - # 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.ListRelatedAccountGroupMembershipsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def search_related_account_group_memberships(self, - request: Optional[Union[recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, - *, - project: Optional[str] = None, - hashed_account_id: Optional[bytes] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.SearchRelatedAccountGroupMembershipsPager: - r"""Search group memberships related to a given account. - - .. 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 recaptchaenterprise_v1 - - def sample_search_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( - project="project_value", - ) - - # Make the request - page_result = client.search_related_account_group_memberships(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]): - The request object. The request message to search related - account group memberships. - project (str): - Required. The name of the project to - search related account group memberships - from. Specify the project name in the - following format: "projects/{project}". - - This corresponds to the ``project`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - hashed_account_id (bytes): - Optional. The unique stable hashed user identifier we - should search connections to. The identifier should - correspond to a ``hashed_account_id`` provided in a - previous ``CreateAssessment`` or ``AnnotateAssessment`` - call. - - This corresponds to the ``hashed_account_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager: - The response to a SearchRelatedAccountGroupMemberships - call. - - 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([project, hashed_account_id]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest): - request = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if project is not None: - request.project = project - if hashed_account_id is not None: - request.hashed_account_id = hashed_account_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.search_related_account_group_memberships] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("project", request.project), - )), - ) - - # 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.SearchRelatedAccountGroupMembershipsPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "RecaptchaEnterpriseServiceClient": - 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__ = ( - "RecaptchaEnterpriseServiceClient", -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py deleted file mode 100644 index 6ceb7f5..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/pagers.py +++ /dev/null @@ -1,502 +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.recaptchaenterprise_v1.types import recaptchaenterprise - - -class ListKeysPager: - """A pager for iterating through ``list_keys`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and - provides an ``__iter__`` method to iterate through its - ``keys`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListKeys`` requests and continue to iterate - through the ``keys`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` - 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[..., recaptchaenterprise.ListKeysResponse], - request: recaptchaenterprise.ListKeysRequest, - response: recaptchaenterprise.ListKeysResponse, - *, - 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.recaptchaenterprise_v1.types.ListKeysRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): - 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 = recaptchaenterprise.ListKeysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[recaptchaenterprise.ListKeysResponse]: - 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[recaptchaenterprise.Key]: - for page in self.pages: - yield from page.keys - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListKeysAsyncPager: - """A pager for iterating through ``list_keys`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``keys`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListKeys`` requests and continue to iterate - through the ``keys`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListKeysResponse` - 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[recaptchaenterprise.ListKeysResponse]], - request: recaptchaenterprise.ListKeysRequest, - response: recaptchaenterprise.ListKeysResponse, - *, - 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.recaptchaenterprise_v1.types.ListKeysRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse): - 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 = recaptchaenterprise.ListKeysRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[recaptchaenterprise.ListKeysResponse]: - 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[recaptchaenterprise.Key]: - async def async_generator(): - async for page in self.pages: - for response in page.keys: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRelatedAccountGroupsPager: - """A pager for iterating through ``list_related_account_groups`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``related_account_groups`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRelatedAccountGroups`` requests and continue to iterate - through the ``related_account_groups`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` - 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[..., recaptchaenterprise.ListRelatedAccountGroupsResponse], - request: recaptchaenterprise.ListRelatedAccountGroupsRequest, - response: recaptchaenterprise.ListRelatedAccountGroupsResponse, - *, - 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse): - 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[recaptchaenterprise.ListRelatedAccountGroupsResponse]: - 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[recaptchaenterprise.RelatedAccountGroup]: - for page in self.pages: - yield from page.related_account_groups - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRelatedAccountGroupsAsyncPager: - """A pager for iterating through ``list_related_account_groups`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``related_account_groups`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRelatedAccountGroups`` requests and continue to iterate - through the ``related_account_groups`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse` - 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[recaptchaenterprise.ListRelatedAccountGroupsResponse]], - request: recaptchaenterprise.ListRelatedAccountGroupsRequest, - response: recaptchaenterprise.ListRelatedAccountGroupsResponse, - *, - 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse): - 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[recaptchaenterprise.ListRelatedAccountGroupsResponse]: - 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[recaptchaenterprise.RelatedAccountGroup]: - async def async_generator(): - async for page in self.pages: - for response in page.related_account_groups: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRelatedAccountGroupMembershipsPager: - """A pager for iterating through ``list_related_account_group_memberships`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``related_account_group_memberships`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListRelatedAccountGroupMemberships`` requests and continue to iterate - through the ``related_account_group_memberships`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` - 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[..., recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse], - request: recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, - response: recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, - *, - 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse): - 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: - 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[recaptchaenterprise.RelatedAccountGroupMembership]: - for page in self.pages: - yield from page.related_account_group_memberships - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListRelatedAccountGroupMembershipsAsyncPager: - """A pager for iterating through ``list_related_account_group_memberships`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``related_account_group_memberships`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListRelatedAccountGroupMemberships`` requests and continue to iterate - through the ``related_account_group_memberships`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse` - 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[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]], - request: recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, - response: recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, - *, - 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.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse): - 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: - 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[recaptchaenterprise.RelatedAccountGroupMembership]: - async def async_generator(): - async for page in self.pages: - for response in page.related_account_group_memberships: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchRelatedAccountGroupMembershipsPager: - """A pager for iterating through ``search_related_account_group_memberships`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``related_account_group_memberships`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``SearchRelatedAccountGroupMemberships`` requests and continue to iterate - through the ``related_account_group_memberships`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` - 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[..., recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse], - request: recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, - response: recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, - *, - 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.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse): - 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: - 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[recaptchaenterprise.RelatedAccountGroupMembership]: - for page in self.pages: - yield from page.related_account_group_memberships - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchRelatedAccountGroupMembershipsAsyncPager: - """A pager for iterating through ``search_related_account_group_memberships`` requests. - - This class thinly wraps an initial - :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``related_account_group_memberships`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``SearchRelatedAccountGroupMemberships`` requests and continue to iterate - through the ``related_account_group_memberships`` field on the - corresponding responses. - - All the usual :class:`google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse` - 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[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]], - request: recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, - response: recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, - *, - 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.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest): - The initial request object. - response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse): - 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: - 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[recaptchaenterprise.RelatedAccountGroupMembership]: - async def async_generator(): - async for page in self.pages: - for response in page.related_account_group_memberships: - 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/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py deleted file mode 100644 index afd885b..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/__init__.py +++ /dev/null @@ -1,33 +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 RecaptchaEnterpriseServiceTransport -from .grpc import RecaptchaEnterpriseServiceGrpcTransport -from .grpc_asyncio import RecaptchaEnterpriseServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[RecaptchaEnterpriseServiceTransport]] -_transport_registry['grpc'] = RecaptchaEnterpriseServiceGrpcTransport -_transport_registry['grpc_asyncio'] = RecaptchaEnterpriseServiceGrpcAsyncIOTransport - -__all__ = ( - 'RecaptchaEnterpriseServiceTransport', - 'RecaptchaEnterpriseServiceGrpcTransport', - 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py deleted file mode 100644 index f8f3c5b..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/base.py +++ /dev/null @@ -1,317 +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.recaptchaenterprise_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.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class RecaptchaEnterpriseServiceTransport(abc.ABC): - """Abstract transport class for RecaptchaEnterpriseService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'recaptchaenterprise.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_assessment: gapic_v1.method.wrap_method( - self.create_assessment, - default_timeout=600.0, - client_info=client_info, - ), - self.annotate_assessment: gapic_v1.method.wrap_method( - self.annotate_assessment, - default_timeout=600.0, - client_info=client_info, - ), - self.create_key: gapic_v1.method.wrap_method( - self.create_key, - default_timeout=600.0, - client_info=client_info, - ), - self.list_keys: gapic_v1.method.wrap_method( - self.list_keys, - default_timeout=600.0, - client_info=client_info, - ), - self.retrieve_legacy_secret_key: gapic_v1.method.wrap_method( - self.retrieve_legacy_secret_key, - default_timeout=None, - client_info=client_info, - ), - self.get_key: gapic_v1.method.wrap_method( - self.get_key, - default_timeout=600.0, - client_info=client_info, - ), - self.update_key: gapic_v1.method.wrap_method( - self.update_key, - default_timeout=600.0, - client_info=client_info, - ), - self.delete_key: gapic_v1.method.wrap_method( - self.delete_key, - default_timeout=600.0, - client_info=client_info, - ), - self.migrate_key: gapic_v1.method.wrap_method( - self.migrate_key, - default_timeout=None, - client_info=client_info, - ), - self.get_metrics: gapic_v1.method.wrap_method( - self.get_metrics, - default_timeout=None, - client_info=client_info, - ), - self.list_related_account_groups: gapic_v1.method.wrap_method( - self.list_related_account_groups, - default_timeout=None, - client_info=client_info, - ), - self.list_related_account_group_memberships: gapic_v1.method.wrap_method( - self.list_related_account_group_memberships, - default_timeout=None, - client_info=client_info, - ), - self.search_related_account_group_memberships: gapic_v1.method.wrap_method( - self.search_related_account_group_memberships, - default_timeout=None, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def create_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - Union[ - recaptchaenterprise.Assessment, - Awaitable[recaptchaenterprise.Assessment] - ]]: - raise NotImplementedError() - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - Union[ - recaptchaenterprise.AnnotateAssessmentResponse, - Awaitable[recaptchaenterprise.AnnotateAssessmentResponse] - ]]: - raise NotImplementedError() - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - Union[ - recaptchaenterprise.ListKeysResponse, - Awaitable[recaptchaenterprise.ListKeysResponse] - ]]: - raise NotImplementedError() - - @property - def retrieve_legacy_secret_key(self) -> Callable[ - [recaptchaenterprise.RetrieveLegacySecretKeyRequest], - Union[ - recaptchaenterprise.RetrieveLegacySecretKeyResponse, - Awaitable[recaptchaenterprise.RetrieveLegacySecretKeyResponse] - ]]: - raise NotImplementedError() - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def migrate_key(self) -> Callable[ - [recaptchaenterprise.MigrateKeyRequest], - Union[ - recaptchaenterprise.Key, - Awaitable[recaptchaenterprise.Key] - ]]: - raise NotImplementedError() - - @property - def get_metrics(self) -> Callable[ - [recaptchaenterprise.GetMetricsRequest], - Union[ - recaptchaenterprise.Metrics, - Awaitable[recaptchaenterprise.Metrics] - ]]: - raise NotImplementedError() - - @property - def list_related_account_groups(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupsRequest], - Union[ - recaptchaenterprise.ListRelatedAccountGroupsResponse, - Awaitable[recaptchaenterprise.ListRelatedAccountGroupsResponse] - ]]: - raise NotImplementedError() - - @property - def list_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], - Union[ - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, - Awaitable[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse] - ]]: - raise NotImplementedError() - - @property - def search_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], - Union[ - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, - Awaitable[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'RecaptchaEnterpriseServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py deleted file mode 100644 index 606b67a..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py +++ /dev/null @@ -1,592 +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.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore -from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO - - -class RecaptchaEnterpriseServiceGrpcTransport(RecaptchaEnterpriseServiceTransport): - """gRPC backend transport for RecaptchaEnterpriseService. - - Service to determine the likelihood an event is legitimate. - - 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 = 'recaptchaenterprise.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 = 'recaptchaenterprise.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_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - recaptchaenterprise.Assessment]: - r"""Return a callable for the create assessment method over gRPC. - - Creates an Assessment of the likelihood an event is - legitimate. - - Returns: - Callable[[~.CreateAssessmentRequest], - ~.Assessment]: - 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_assessment' not in self._stubs: - self._stubs['create_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', - request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.Assessment.deserialize, - ) - return self._stubs['create_assessment'] - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - recaptchaenterprise.AnnotateAssessmentResponse]: - r"""Return a callable for the annotate assessment method over gRPC. - - Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fraudulent. - - Returns: - Callable[[~.AnnotateAssessmentRequest], - ~.AnnotateAssessmentResponse]: - 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 'annotate_assessment' not in self._stubs: - self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', - request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, - ) - return self._stubs['annotate_assessment'] - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the create key method over gRPC. - - Creates a new reCAPTCHA Enterprise key. - - Returns: - Callable[[~.CreateKeyRequest], - ~.Key]: - 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_key' not in self._stubs: - self._stubs['create_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', - request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['create_key'] - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - recaptchaenterprise.ListKeysResponse]: - r"""Return a callable for the list keys method over gRPC. - - Returns the list of all keys that belong to a - project. - - Returns: - Callable[[~.ListKeysRequest], - ~.ListKeysResponse]: - 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_keys' not in self._stubs: - self._stubs['list_keys'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', - request_serializer=recaptchaenterprise.ListKeysRequest.serialize, - response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, - ) - return self._stubs['list_keys'] - - @property - def retrieve_legacy_secret_key(self) -> Callable[ - [recaptchaenterprise.RetrieveLegacySecretKeyRequest], - recaptchaenterprise.RetrieveLegacySecretKeyResponse]: - r"""Return a callable for the retrieve legacy secret key method over gRPC. - - Returns the secret key related to the specified - public key. You must use the legacy secret key only in a - 3rd party integration with legacy reCAPTCHA. - - Returns: - Callable[[~.RetrieveLegacySecretKeyRequest], - ~.RetrieveLegacySecretKeyResponse]: - 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 'retrieve_legacy_secret_key' not in self._stubs: - self._stubs['retrieve_legacy_secret_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RetrieveLegacySecretKey', - request_serializer=recaptchaenterprise.RetrieveLegacySecretKeyRequest.serialize, - response_deserializer=recaptchaenterprise.RetrieveLegacySecretKeyResponse.deserialize, - ) - return self._stubs['retrieve_legacy_secret_key'] - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the get key method over gRPC. - - Returns the specified key. - - Returns: - Callable[[~.GetKeyRequest], - ~.Key]: - 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_key' not in self._stubs: - self._stubs['get_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', - request_serializer=recaptchaenterprise.GetKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['get_key'] - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the update key method over gRPC. - - Updates the specified key. - - Returns: - Callable[[~.UpdateKeyRequest], - ~.Key]: - 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_key' not in self._stubs: - self._stubs['update_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', - request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['update_key'] - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete key method over gRPC. - - Deletes the specified key. - - Returns: - Callable[[~.DeleteKeyRequest], - ~.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_key' not in self._stubs: - self._stubs['delete_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', - request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_key'] - - @property - def migrate_key(self) -> Callable[ - [recaptchaenterprise.MigrateKeyRequest], - recaptchaenterprise.Key]: - r"""Return a callable for the migrate key method over gRPC. - - Migrates an existing key from reCAPTCHA to reCAPTCHA - Enterprise. Once a key is migrated, it can be used from - either product. SiteVerify requests are billed as - CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Site Key, and - your user must have the reCAPTCHA Enterprise Admin IAM - role in the destination project. - - Returns: - Callable[[~.MigrateKeyRequest], - ~.Key]: - 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 'migrate_key' not in self._stubs: - self._stubs['migrate_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/MigrateKey', - request_serializer=recaptchaenterprise.MigrateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['migrate_key'] - - @property - def get_metrics(self) -> Callable[ - [recaptchaenterprise.GetMetricsRequest], - recaptchaenterprise.Metrics]: - r"""Return a callable for the get metrics method over gRPC. - - Get some aggregated metrics for a Key. This data can - be used to build dashboards. - - Returns: - Callable[[~.GetMetricsRequest], - ~.Metrics]: - 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_metrics' not in self._stubs: - self._stubs['get_metrics'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetMetrics', - request_serializer=recaptchaenterprise.GetMetricsRequest.serialize, - response_deserializer=recaptchaenterprise.Metrics.deserialize, - ) - return self._stubs['get_metrics'] - - @property - def list_related_account_groups(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupsRequest], - recaptchaenterprise.ListRelatedAccountGroupsResponse]: - r"""Return a callable for the list related account groups method over gRPC. - - List groups of related accounts. - - Returns: - Callable[[~.ListRelatedAccountGroupsRequest], - ~.ListRelatedAccountGroupsResponse]: - 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_related_account_groups' not in self._stubs: - self._stubs['list_related_account_groups'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroups', - request_serializer=recaptchaenterprise.ListRelatedAccountGroupsRequest.serialize, - response_deserializer=recaptchaenterprise.ListRelatedAccountGroupsResponse.deserialize, - ) - return self._stubs['list_related_account_groups'] - - @property - def list_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]: - r"""Return a callable for the list related account group - memberships method over gRPC. - - Get memberships in a group of related accounts. - - Returns: - Callable[[~.ListRelatedAccountGroupMembershipsRequest], - ~.ListRelatedAccountGroupMembershipsResponse]: - 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_related_account_group_memberships' not in self._stubs: - self._stubs['list_related_account_group_memberships'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroupMemberships', - request_serializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest.serialize, - response_deserializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse.deserialize, - ) - return self._stubs['list_related_account_group_memberships'] - - @property - def search_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]: - r"""Return a callable for the search related account group - memberships method over gRPC. - - Search group memberships related to a given account. - - Returns: - Callable[[~.SearchRelatedAccountGroupMembershipsRequest], - ~.SearchRelatedAccountGroupMembershipsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_related_account_group_memberships' not in self._stubs: - self._stubs['search_related_account_group_memberships'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/SearchRelatedAccountGroupMemberships', - request_serializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest.serialize, - response_deserializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse.deserialize, - ) - return self._stubs['search_related_account_group_memberships'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'RecaptchaEnterpriseServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py deleted file mode 100644 index 8d041fc..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,591 +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.recaptchaenterprise_v1.types import recaptchaenterprise -from google.protobuf import empty_pb2 # type: ignore -from .base import RecaptchaEnterpriseServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import RecaptchaEnterpriseServiceGrpcTransport - - -class RecaptchaEnterpriseServiceGrpcAsyncIOTransport(RecaptchaEnterpriseServiceTransport): - """gRPC AsyncIO backend transport for RecaptchaEnterpriseService. - - Service to determine the likelihood an event is legitimate. - - 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 = 'recaptchaenterprise.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 = 'recaptchaenterprise.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_assessment(self) -> Callable[ - [recaptchaenterprise.CreateAssessmentRequest], - Awaitable[recaptchaenterprise.Assessment]]: - r"""Return a callable for the create assessment method over gRPC. - - Creates an Assessment of the likelihood an event is - legitimate. - - Returns: - Callable[[~.CreateAssessmentRequest], - Awaitable[~.Assessment]]: - 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_assessment' not in self._stubs: - self._stubs['create_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateAssessment', - request_serializer=recaptchaenterprise.CreateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.Assessment.deserialize, - ) - return self._stubs['create_assessment'] - - @property - def annotate_assessment(self) -> Callable[ - [recaptchaenterprise.AnnotateAssessmentRequest], - Awaitable[recaptchaenterprise.AnnotateAssessmentResponse]]: - r"""Return a callable for the annotate assessment method over gRPC. - - Annotates a previously created Assessment to provide - additional information on whether the event turned out - to be authentic or fraudulent. - - Returns: - Callable[[~.AnnotateAssessmentRequest], - Awaitable[~.AnnotateAssessmentResponse]]: - 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 'annotate_assessment' not in self._stubs: - self._stubs['annotate_assessment'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/AnnotateAssessment', - request_serializer=recaptchaenterprise.AnnotateAssessmentRequest.serialize, - response_deserializer=recaptchaenterprise.AnnotateAssessmentResponse.deserialize, - ) - return self._stubs['annotate_assessment'] - - @property - def create_key(self) -> Callable[ - [recaptchaenterprise.CreateKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the create key method over gRPC. - - Creates a new reCAPTCHA Enterprise key. - - Returns: - Callable[[~.CreateKeyRequest], - Awaitable[~.Key]]: - 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_key' not in self._stubs: - self._stubs['create_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/CreateKey', - request_serializer=recaptchaenterprise.CreateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['create_key'] - - @property - def list_keys(self) -> Callable[ - [recaptchaenterprise.ListKeysRequest], - Awaitable[recaptchaenterprise.ListKeysResponse]]: - r"""Return a callable for the list keys method over gRPC. - - Returns the list of all keys that belong to a - project. - - Returns: - Callable[[~.ListKeysRequest], - Awaitable[~.ListKeysResponse]]: - 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_keys' not in self._stubs: - self._stubs['list_keys'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListKeys', - request_serializer=recaptchaenterprise.ListKeysRequest.serialize, - response_deserializer=recaptchaenterprise.ListKeysResponse.deserialize, - ) - return self._stubs['list_keys'] - - @property - def retrieve_legacy_secret_key(self) -> Callable[ - [recaptchaenterprise.RetrieveLegacySecretKeyRequest], - Awaitable[recaptchaenterprise.RetrieveLegacySecretKeyResponse]]: - r"""Return a callable for the retrieve legacy secret key method over gRPC. - - Returns the secret key related to the specified - public key. You must use the legacy secret key only in a - 3rd party integration with legacy reCAPTCHA. - - Returns: - Callable[[~.RetrieveLegacySecretKeyRequest], - Awaitable[~.RetrieveLegacySecretKeyResponse]]: - 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 'retrieve_legacy_secret_key' not in self._stubs: - self._stubs['retrieve_legacy_secret_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/RetrieveLegacySecretKey', - request_serializer=recaptchaenterprise.RetrieveLegacySecretKeyRequest.serialize, - response_deserializer=recaptchaenterprise.RetrieveLegacySecretKeyResponse.deserialize, - ) - return self._stubs['retrieve_legacy_secret_key'] - - @property - def get_key(self) -> Callable[ - [recaptchaenterprise.GetKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the get key method over gRPC. - - Returns the specified key. - - Returns: - Callable[[~.GetKeyRequest], - Awaitable[~.Key]]: - 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_key' not in self._stubs: - self._stubs['get_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetKey', - request_serializer=recaptchaenterprise.GetKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['get_key'] - - @property - def update_key(self) -> Callable[ - [recaptchaenterprise.UpdateKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the update key method over gRPC. - - Updates the specified key. - - Returns: - Callable[[~.UpdateKeyRequest], - Awaitable[~.Key]]: - 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_key' not in self._stubs: - self._stubs['update_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/UpdateKey', - request_serializer=recaptchaenterprise.UpdateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['update_key'] - - @property - def delete_key(self) -> Callable[ - [recaptchaenterprise.DeleteKeyRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete key method over gRPC. - - Deletes the specified key. - - Returns: - Callable[[~.DeleteKeyRequest], - 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_key' not in self._stubs: - self._stubs['delete_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/DeleteKey', - request_serializer=recaptchaenterprise.DeleteKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_key'] - - @property - def migrate_key(self) -> Callable[ - [recaptchaenterprise.MigrateKeyRequest], - Awaitable[recaptchaenterprise.Key]]: - r"""Return a callable for the migrate key method over gRPC. - - Migrates an existing key from reCAPTCHA to reCAPTCHA - Enterprise. Once a key is migrated, it can be used from - either product. SiteVerify requests are billed as - CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Site Key, and - your user must have the reCAPTCHA Enterprise Admin IAM - role in the destination project. - - Returns: - Callable[[~.MigrateKeyRequest], - Awaitable[~.Key]]: - 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 'migrate_key' not in self._stubs: - self._stubs['migrate_key'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/MigrateKey', - request_serializer=recaptchaenterprise.MigrateKeyRequest.serialize, - response_deserializer=recaptchaenterprise.Key.deserialize, - ) - return self._stubs['migrate_key'] - - @property - def get_metrics(self) -> Callable[ - [recaptchaenterprise.GetMetricsRequest], - Awaitable[recaptchaenterprise.Metrics]]: - r"""Return a callable for the get metrics method over gRPC. - - Get some aggregated metrics for a Key. This data can - be used to build dashboards. - - Returns: - Callable[[~.GetMetricsRequest], - Awaitable[~.Metrics]]: - 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_metrics' not in self._stubs: - self._stubs['get_metrics'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/GetMetrics', - request_serializer=recaptchaenterprise.GetMetricsRequest.serialize, - response_deserializer=recaptchaenterprise.Metrics.deserialize, - ) - return self._stubs['get_metrics'] - - @property - def list_related_account_groups(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupsRequest], - Awaitable[recaptchaenterprise.ListRelatedAccountGroupsResponse]]: - r"""Return a callable for the list related account groups method over gRPC. - - List groups of related accounts. - - Returns: - Callable[[~.ListRelatedAccountGroupsRequest], - Awaitable[~.ListRelatedAccountGroupsResponse]]: - 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_related_account_groups' not in self._stubs: - self._stubs['list_related_account_groups'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroups', - request_serializer=recaptchaenterprise.ListRelatedAccountGroupsRequest.serialize, - response_deserializer=recaptchaenterprise.ListRelatedAccountGroupsResponse.deserialize, - ) - return self._stubs['list_related_account_groups'] - - @property - def list_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest], - Awaitable[recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]]: - r"""Return a callable for the list related account group - memberships method over gRPC. - - Get memberships in a group of related accounts. - - Returns: - Callable[[~.ListRelatedAccountGroupMembershipsRequest], - Awaitable[~.ListRelatedAccountGroupMembershipsResponse]]: - 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_related_account_group_memberships' not in self._stubs: - self._stubs['list_related_account_group_memberships'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/ListRelatedAccountGroupMemberships', - request_serializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest.serialize, - response_deserializer=recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse.deserialize, - ) - return self._stubs['list_related_account_group_memberships'] - - @property - def search_related_account_group_memberships(self) -> Callable[ - [recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest], - Awaitable[recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]]: - r"""Return a callable for the search related account group - memberships method over gRPC. - - Search group memberships related to a given account. - - Returns: - Callable[[~.SearchRelatedAccountGroupMembershipsRequest], - Awaitable[~.SearchRelatedAccountGroupMembershipsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'search_related_account_group_memberships' not in self._stubs: - self._stubs['search_related_account_group_memberships'] = self.grpc_channel.unary_unary( - '/google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService/SearchRelatedAccountGroupMemberships', - request_serializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest.serialize, - response_deserializer=recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse.deserialize, - ) - return self._stubs['search_related_account_group_memberships'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'RecaptchaEnterpriseServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.py deleted file mode 100644 index 3070373..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/__init__.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 .recaptchaenterprise import ( - AccountDefenderAssessment, - AccountVerificationInfo, - AndroidKeySettings, - AnnotateAssessmentRequest, - AnnotateAssessmentResponse, - Assessment, - ChallengeMetrics, - CreateAssessmentRequest, - CreateKeyRequest, - DeleteKeyRequest, - EndpointVerificationInfo, - Event, - FraudPreventionAssessment, - GetKeyRequest, - GetMetricsRequest, - IOSKeySettings, - Key, - ListKeysRequest, - ListKeysResponse, - ListRelatedAccountGroupMembershipsRequest, - ListRelatedAccountGroupMembershipsResponse, - ListRelatedAccountGroupsRequest, - ListRelatedAccountGroupsResponse, - Metrics, - MigrateKeyRequest, - PrivatePasswordLeakVerification, - RelatedAccountGroup, - RelatedAccountGroupMembership, - RetrieveLegacySecretKeyRequest, - RetrieveLegacySecretKeyResponse, - RiskAnalysis, - ScoreDistribution, - ScoreMetrics, - SearchRelatedAccountGroupMembershipsRequest, - SearchRelatedAccountGroupMembershipsResponse, - TestingOptions, - TokenProperties, - TransactionData, - TransactionEvent, - UpdateKeyRequest, - WafSettings, - WebKeySettings, -) - -__all__ = ( - 'AccountDefenderAssessment', - 'AccountVerificationInfo', - 'AndroidKeySettings', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'Assessment', - 'ChallengeMetrics', - 'CreateAssessmentRequest', - 'CreateKeyRequest', - 'DeleteKeyRequest', - 'EndpointVerificationInfo', - 'Event', - 'FraudPreventionAssessment', - 'GetKeyRequest', - 'GetMetricsRequest', - 'IOSKeySettings', - 'Key', - 'ListKeysRequest', - 'ListKeysResponse', - 'ListRelatedAccountGroupMembershipsRequest', - 'ListRelatedAccountGroupMembershipsResponse', - 'ListRelatedAccountGroupsRequest', - 'ListRelatedAccountGroupsResponse', - 'Metrics', - 'MigrateKeyRequest', - 'PrivatePasswordLeakVerification', - 'RelatedAccountGroup', - 'RelatedAccountGroupMembership', - 'RetrieveLegacySecretKeyRequest', - 'RetrieveLegacySecretKeyResponse', - 'RiskAnalysis', - 'ScoreDistribution', - 'ScoreMetrics', - 'SearchRelatedAccountGroupMembershipsRequest', - 'SearchRelatedAccountGroupMembershipsResponse', - 'TestingOptions', - 'TokenProperties', - 'TransactionData', - 'TransactionEvent', - 'UpdateKeyRequest', - 'WafSettings', - 'WebKeySettings', -) diff --git a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py b/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py deleted file mode 100644 index 270d5ac..0000000 --- a/owl-bot-staging/v1/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py +++ /dev/null @@ -1,2232 +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.protobuf import field_mask_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.recaptchaenterprise.v1', - manifest={ - 'CreateAssessmentRequest', - 'TransactionEvent', - 'AnnotateAssessmentRequest', - 'AnnotateAssessmentResponse', - 'EndpointVerificationInfo', - 'AccountVerificationInfo', - 'PrivatePasswordLeakVerification', - 'Assessment', - 'Event', - 'TransactionData', - 'RiskAnalysis', - 'TokenProperties', - 'FraudPreventionAssessment', - 'AccountDefenderAssessment', - 'CreateKeyRequest', - 'ListKeysRequest', - 'ListKeysResponse', - 'RetrieveLegacySecretKeyRequest', - 'GetKeyRequest', - 'UpdateKeyRequest', - 'DeleteKeyRequest', - 'MigrateKeyRequest', - 'GetMetricsRequest', - 'Metrics', - 'RetrieveLegacySecretKeyResponse', - 'Key', - 'TestingOptions', - 'WebKeySettings', - 'AndroidKeySettings', - 'IOSKeySettings', - 'ScoreDistribution', - 'ScoreMetrics', - 'ChallengeMetrics', - 'ListRelatedAccountGroupMembershipsRequest', - 'ListRelatedAccountGroupMembershipsResponse', - 'ListRelatedAccountGroupsRequest', - 'ListRelatedAccountGroupsResponse', - 'SearchRelatedAccountGroupMembershipsRequest', - 'SearchRelatedAccountGroupMembershipsResponse', - 'RelatedAccountGroupMembership', - 'RelatedAccountGroup', - 'WafSettings', - }, -) - - -class CreateAssessmentRequest(proto.Message): - r"""The create assessment request message. - - Attributes: - parent (str): - Required. The name of the project in which - the assessment will be created, in the format - "projects/{project}". - assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): - Required. The assessment details. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - assessment: 'Assessment' = proto.Field( - proto.MESSAGE, - number=2, - message='Assessment', - ) - - -class TransactionEvent(proto.Message): - r"""Describes an event in the lifecycle of a payment transaction. - - Attributes: - event_type (google.cloud.recaptchaenterprise_v1.types.TransactionEvent.TransactionEventType): - Optional. The type of this transaction event. - reason (str): - Optional. The reason or standardized code - that corresponds with this transaction event, if - one exists. For example, a CHARGEBACK event with - code 6005. - value (float): - Optional. The value that corresponds with - this transaction event, if one exists. For - example, a refund event where $5.00 was - refunded. Currency is obtained from the original - transaction data. - event_time (google.protobuf.timestamp_pb2.Timestamp): - Optional. Timestamp when this transaction - event occurred; otherwise assumed to be the time - of the API call. - """ - class TransactionEventType(proto.Enum): - r"""Enum that represents an event in the payment transaction - lifecycle. - - Values: - TRANSACTION_EVENT_TYPE_UNSPECIFIED (0): - Default, unspecified event type. - MERCHANT_APPROVE (1): - Indicates that the transaction is approved by the merchant. - The accompanying reasons can include terms such as - 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. - MERCHANT_DENY (2): - Indicates that the transaction is denied and concluded due - to risks detected by the merchant. The accompanying reasons - can include terms such as 'INHOUSE', 'ACCERTIFY', - 'CYBERSOURCE', or 'MANUAL_REVIEW'. - MANUAL_REVIEW (3): - Indicates that the transaction is being - evaluated by a human, due to suspicion or risk. - AUTHORIZATION (4): - Indicates that the authorization attempt with - the card issuer succeeded. - AUTHORIZATION_DECLINE (5): - Indicates that the authorization attempt with - the card issuer failed. The accompanying reasons - can include Visa's '54' indicating that the card - is expired, or '82' indicating that the CVV is - incorrect. - PAYMENT_CAPTURE (6): - Indicates that the transaction is completed - because the funds were settled. - PAYMENT_CAPTURE_DECLINE (7): - Indicates that the transaction could not be - completed because the funds were not settled. - CANCEL (8): - Indicates that the transaction has been canceled. Specify - the reason for the cancellation. For example, - 'INSUFFICIENT_INVENTORY'. - CHARGEBACK_INQUIRY (9): - Indicates that the merchant has received a - chargeback inquiry due to fraud for the - transaction, requesting additional information - before a fraud chargeback is officially issued - and a formal chargeback notification is sent. - CHARGEBACK_ALERT (10): - Indicates that the merchant has received a - chargeback alert due to fraud for the - transaction. The process of resolving the - dispute without involving the payment network is - started. - FRAUD_NOTIFICATION (11): - Indicates that a fraud notification is issued for the - transaction, sent by the payment instrument's issuing bank - because the transaction appears to be fraudulent. We - recommend including TC40 or SAFE data in the ``reason`` - field for this event type. For partial chargebacks, we - recommend that you include an amount in the ``value`` field. - CHARGEBACK (12): - Indicates that the merchant is informed by the payment - network that the transaction has entered the chargeback - process due to fraud. Reason code examples include - Discover's '6005' and '6041'. For partial chargebacks, we - recommend that you include an amount in the ``value`` field. - CHARGEBACK_REPRESENTMENT (13): - Indicates that the transaction has entered the chargeback - process due to fraud, and that the merchant has chosen to - enter representment. Reason examples include Discover's - '6005' and '6041'. For partial chargebacks, we recommend - that you include an amount in the ``value`` field. - CHARGEBACK_REVERSE (14): - Indicates that the transaction has had a fraud chargeback - which was illegitimate and was reversed as a result. For - partial chargebacks, we recommend that you include an amount - in the ``value`` field. - REFUND_REQUEST (15): - Indicates that the merchant has received a refund for a - completed transaction. For partial refunds, we recommend - that you include an amount in the ``value`` field. Reason - example: 'TAX_EXEMPT' (partial refund of exempt tax) - REFUND_DECLINE (16): - Indicates that the merchant has received a refund request - for this transaction, but that they have declined it. For - partial refunds, we recommend that you include an amount in - the ``value`` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - REFUND (17): - Indicates that the completed transaction was refunded by the - merchant. For partial refunds, we recommend that you include - an amount in the ``value`` field. Reason example: - 'TAX_EXEMPT' (partial refund of exempt tax) - REFUND_REVERSE (18): - Indicates that the completed transaction was refunded by the - merchant, and that this refund was reversed. For partial - refunds, we recommend that you include an amount in the - ``value`` field. - """ - TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0 - MERCHANT_APPROVE = 1 - MERCHANT_DENY = 2 - MANUAL_REVIEW = 3 - AUTHORIZATION = 4 - AUTHORIZATION_DECLINE = 5 - PAYMENT_CAPTURE = 6 - PAYMENT_CAPTURE_DECLINE = 7 - CANCEL = 8 - CHARGEBACK_INQUIRY = 9 - CHARGEBACK_ALERT = 10 - FRAUD_NOTIFICATION = 11 - CHARGEBACK = 12 - CHARGEBACK_REPRESENTMENT = 13 - CHARGEBACK_REVERSE = 14 - REFUND_REQUEST = 15 - REFUND_DECLINE = 16 - REFUND = 17 - REFUND_REVERSE = 18 - - event_type: TransactionEventType = proto.Field( - proto.ENUM, - number=1, - enum=TransactionEventType, - ) - reason: str = proto.Field( - proto.STRING, - number=2, - ) - value: float = proto.Field( - proto.DOUBLE, - number=3, - ) - event_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - - -class AnnotateAssessmentRequest(proto.Message): - r"""The request message to annotate an Assessment. - - Attributes: - name (str): - Required. The resource name of the - Assessment, in the format - "projects/{project}/assessments/{assessment}". - annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): - Optional. The annotation that will be - assigned to the Event. This field can be left - empty to provide reasons that apply to an event - without concluding whether the event is - legitimate or fraudulent. - reasons (MutableSequence[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Reason]): - Optional. Optional reasons for the annotation - that will be assigned to the Event. - hashed_account_id (bytes): - Optional. Unique stable hashed user identifier to apply to - the assessment. This is an alternative to setting the - hashed_account_id in CreateAssessment, for example when the - account identifier is not yet known in the initial request. - It is recommended that the identifier is hashed using - hmac-sha256 with stable secret. - transaction_event (google.cloud.recaptchaenterprise_v1.types.TransactionEvent): - Optional. If the assessment is part of a - payment transaction, provide details on payment - lifecycle events that occur in the transaction. - """ - class Annotation(proto.Enum): - r"""Enum that represents the types of annotations. - - Values: - ANNOTATION_UNSPECIFIED (0): - Default unspecified type. - LEGITIMATE (1): - Provides information that the event turned - out to be legitimate. - FRAUDULENT (2): - Provides information that the event turned - out to be fraudulent. - PASSWORD_CORRECT (3): - Provides information that the event was related to a login - event in which the user typed the correct password. - Deprecated, prefer indicating CORRECT_PASSWORD through the - reasons field instead. - PASSWORD_INCORRECT (4): - Provides information that the event was related to a login - event in which the user typed the incorrect password. - Deprecated, prefer indicating INCORRECT_PASSWORD through the - reasons field instead. - """ - ANNOTATION_UNSPECIFIED = 0 - LEGITIMATE = 1 - FRAUDULENT = 2 - PASSWORD_CORRECT = 3 - PASSWORD_INCORRECT = 4 - - class Reason(proto.Enum): - r"""Enum that represents potential reasons for annotating an - assessment. - - Values: - REASON_UNSPECIFIED (0): - Default unspecified reason. - CHARGEBACK (1): - Indicates that the transaction had a chargeback issued with - no other details. When possible, specify the type by using - CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - CHARGEBACK_FRAUD (8): - Indicates that the transaction had a - chargeback issued related to an alleged - unauthorized transaction from the cardholder's - perspective (for example, the card number was - stolen). - CHARGEBACK_DISPUTE (9): - Indicates that the transaction had a - chargeback issued related to the cardholder - having provided their card details but allegedly - not being satisfied with the purchase (for - example, misrepresentation, attempted - cancellation). - REFUND (10): - Indicates that the completed payment - transaction was refunded by the seller. - REFUND_FRAUD (11): - Indicates that the completed payment - transaction was determined to be fraudulent by - the seller, and was cancelled and refunded as a - result. - TRANSACTION_ACCEPTED (12): - Indicates that the payment transaction was - accepted, and the user was charged. - TRANSACTION_DECLINED (13): - Indicates that the payment transaction was - declined, for example due to invalid card - details. - PAYMENT_HEURISTICS (2): - Indicates the transaction associated with the - assessment is suspected of being fraudulent - based on the payment method, billing details, - shipping address or other transaction - information. - INITIATED_TWO_FACTOR (7): - Indicates that the user was served a 2FA challenge. An old - assessment with ``ENUM_VALUES.INITIATED_TWO_FACTOR`` reason - that has not been overwritten with ``PASSED_TWO_FACTOR`` is - treated as an abandoned 2FA flow. This is equivalent to - ``FAILED_TWO_FACTOR``. - PASSED_TWO_FACTOR (3): - Indicates that the user passed a 2FA - challenge. - FAILED_TWO_FACTOR (4): - Indicates that the user failed a 2FA - challenge. - CORRECT_PASSWORD (5): - Indicates the user provided the correct - password. - INCORRECT_PASSWORD (6): - Indicates the user provided an incorrect - password. - SOCIAL_SPAM (14): - Indicates that the user sent unwanted and - abusive messages to other users of the platform, - such as spam, scams, phishing, or social - engineering. - """ - REASON_UNSPECIFIED = 0 - CHARGEBACK = 1 - CHARGEBACK_FRAUD = 8 - CHARGEBACK_DISPUTE = 9 - REFUND = 10 - REFUND_FRAUD = 11 - TRANSACTION_ACCEPTED = 12 - TRANSACTION_DECLINED = 13 - PAYMENT_HEURISTICS = 2 - INITIATED_TWO_FACTOR = 7 - PASSED_TWO_FACTOR = 3 - FAILED_TWO_FACTOR = 4 - CORRECT_PASSWORD = 5 - INCORRECT_PASSWORD = 6 - SOCIAL_SPAM = 14 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - annotation: Annotation = proto.Field( - proto.ENUM, - number=2, - enum=Annotation, - ) - reasons: MutableSequence[Reason] = proto.RepeatedField( - proto.ENUM, - number=3, - enum=Reason, - ) - hashed_account_id: bytes = proto.Field( - proto.BYTES, - number=4, - ) - transaction_event: 'TransactionEvent' = proto.Field( - proto.MESSAGE, - number=5, - message='TransactionEvent', - ) - - -class AnnotateAssessmentResponse(proto.Message): - r"""Empty response for AnnotateAssessment. - """ - - -class EndpointVerificationInfo(proto.Message): - r"""Information about a verification endpoint that can be used - for 2FA. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - email_address (str): - Email address for which to trigger a - verification request. - - This field is a member of `oneof`_ ``endpoint``. - phone_number (str): - Phone number for which to trigger a - verification request. Should be given in E.164 - format. - - This field is a member of `oneof`_ ``endpoint``. - request_token (str): - Output only. Token to provide to the client - to trigger endpoint verification. It must be - used within 15 minutes. - last_verification_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Timestamp of the last successful - verification for the endpoint, if any. - """ - - email_address: str = proto.Field( - proto.STRING, - number=1, - oneof='endpoint', - ) - phone_number: str = proto.Field( - proto.STRING, - number=2, - oneof='endpoint', - ) - request_token: str = proto.Field( - proto.STRING, - number=3, - ) - last_verification_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - - -class AccountVerificationInfo(proto.Message): - r"""Information about account verification, used for identity - verification. - - Attributes: - endpoints (MutableSequence[google.cloud.recaptchaenterprise_v1.types.EndpointVerificationInfo]): - Endpoints that can be used for identity - verification. - language_code (str): - Language code preference for the verification - message, set as a IETF BCP 47 language code. - latest_verification_result (google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo.Result): - Output only. Result of the latest account - verification challenge. - username (str): - Username of the account that is being - verified. Deprecated. Customers should now - provide the hashed account ID field in Event. - """ - class Result(proto.Enum): - r"""Result of the account verification as contained in the - verdict token issued at the end of the verification flow. - - Values: - RESULT_UNSPECIFIED (0): - No information about the latest account - verification. - SUCCESS_USER_VERIFIED (1): - The user was successfully verified. This - means the account verification challenge was - successfully completed. - ERROR_USER_NOT_VERIFIED (2): - The user failed the verification challenge. - ERROR_SITE_ONBOARDING_INCOMPLETE (3): - The site is not properly onboarded to use the - account verification feature. - ERROR_RECIPIENT_NOT_ALLOWED (4): - The recipient is not allowed for account - verification. This can occur during integration - but should not occur in production. - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED (5): - The recipient has already been sent too many - verification codes in a short amount of time. - ERROR_CRITICAL_INTERNAL (6): - The verification flow could not be completed - due to a critical internal error. - ERROR_CUSTOMER_QUOTA_EXHAUSTED (7): - The client has exceeded their two factor - request quota for this period of time. - ERROR_VERIFICATION_BYPASSED (8): - The request cannot be processed at the time - because of an incident. This bypass can be - restricted to a problematic destination email - domain, a customer, or could affect the entire - service. - ERROR_VERDICT_MISMATCH (9): - The request parameters do not match with the - token provided and cannot be processed. - """ - RESULT_UNSPECIFIED = 0 - SUCCESS_USER_VERIFIED = 1 - ERROR_USER_NOT_VERIFIED = 2 - ERROR_SITE_ONBOARDING_INCOMPLETE = 3 - ERROR_RECIPIENT_NOT_ALLOWED = 4 - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5 - ERROR_CRITICAL_INTERNAL = 6 - ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7 - ERROR_VERIFICATION_BYPASSED = 8 - ERROR_VERDICT_MISMATCH = 9 - - endpoints: MutableSequence['EndpointVerificationInfo'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='EndpointVerificationInfo', - ) - language_code: str = proto.Field( - proto.STRING, - number=3, - ) - latest_verification_result: Result = proto.Field( - proto.ENUM, - number=7, - enum=Result, - ) - username: str = proto.Field( - proto.STRING, - number=2, - ) - - -class PrivatePasswordLeakVerification(proto.Message): - r"""Private password leak verification info. - - Attributes: - lookup_hash_prefix (bytes): - Optional. Exactly 26-bit prefix of the - SHA-256 hash of the canonicalized username. It - is used to look up password leaks associated - with that hash prefix. - encrypted_user_credentials_hash (bytes): - Optional. Encrypted Scrypt hash of the canonicalized - username+password. It is re-encrypted by the server and - returned through ``reencrypted_user_credentials_hash``. - encrypted_leak_match_prefixes (MutableSequence[bytes]): - Output only. List of prefixes of the encrypted potential - password leaks that matched the given parameters. They must - be compared with the client-side decryption prefix of - ``reencrypted_user_credentials_hash`` - reencrypted_user_credentials_hash (bytes): - Output only. Corresponds to the re-encryption of the - ``encrypted_user_credentials_hash`` field. It is used to - match potential password leaks within - ``encrypted_leak_match_prefixes``. - """ - - lookup_hash_prefix: bytes = proto.Field( - proto.BYTES, - number=1, - ) - encrypted_user_credentials_hash: bytes = proto.Field( - proto.BYTES, - number=2, - ) - encrypted_leak_match_prefixes: MutableSequence[bytes] = proto.RepeatedField( - proto.BYTES, - number=3, - ) - reencrypted_user_credentials_hash: bytes = proto.Field( - proto.BYTES, - number=4, - ) - - -class Assessment(proto.Message): - r"""A reCAPTCHA Enterprise assessment resource. - - Attributes: - name (str): - Output only. The resource name for the - Assessment in the format - "projects/{project}/assessments/{assessment}". - event (google.cloud.recaptchaenterprise_v1.types.Event): - The event being assessed. - risk_analysis (google.cloud.recaptchaenterprise_v1.types.RiskAnalysis): - Output only. The risk analysis result for the - event being assessed. - token_properties (google.cloud.recaptchaenterprise_v1.types.TokenProperties): - Output only. Properties of the provided event - token. - account_verification (google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo): - Account verification information for identity - verification. The assessment event must include - a token and site key to use this feature. - account_defender_assessment (google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment): - Assessment returned by account defender when a - hashed_account_id is provided. - private_password_leak_verification (google.cloud.recaptchaenterprise_v1.types.PrivatePasswordLeakVerification): - The private password leak verification field - contains the parameters that are used to to - check for leaks privately without sharing user - credentials. - fraud_prevention_assessment (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment): - Assessment returned by Fraud Prevention when - TransactionData is provided. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - event: 'Event' = proto.Field( - proto.MESSAGE, - number=2, - message='Event', - ) - risk_analysis: 'RiskAnalysis' = proto.Field( - proto.MESSAGE, - number=3, - message='RiskAnalysis', - ) - token_properties: 'TokenProperties' = proto.Field( - proto.MESSAGE, - number=4, - message='TokenProperties', - ) - account_verification: 'AccountVerificationInfo' = proto.Field( - proto.MESSAGE, - number=5, - message='AccountVerificationInfo', - ) - account_defender_assessment: 'AccountDefenderAssessment' = proto.Field( - proto.MESSAGE, - number=6, - message='AccountDefenderAssessment', - ) - private_password_leak_verification: 'PrivatePasswordLeakVerification' = proto.Field( - proto.MESSAGE, - number=8, - message='PrivatePasswordLeakVerification', - ) - fraud_prevention_assessment: 'FraudPreventionAssessment' = proto.Field( - proto.MESSAGE, - number=11, - message='FraudPreventionAssessment', - ) - - -class Event(proto.Message): - r"""The event being assessed. - - Attributes: - token (str): - Optional. The user response token provided by - the reCAPTCHA Enterprise client-side integration - on your site. - site_key (str): - Optional. The site key that was used to - invoke reCAPTCHA Enterprise on your site and - generate the token. - user_agent (str): - Optional. The user agent present in the - request from the user's device related to this - event. - user_ip_address (str): - Optional. The IP address in the request from - the user's device related to this event. - expected_action (str): - Optional. The expected action for this type - of event. This should be the same action - provided at token generation time on client-side - platforms already integrated with recaptcha - enterprise. - hashed_account_id (bytes): - Optional. Unique stable hashed user - identifier for the request. The identifier must - be hashed using hmac-sha256 with stable secret. - transaction_data (google.cloud.recaptchaenterprise_v1.types.TransactionData): - Optional. Data describing a payment - transaction to be assessed. Sending this data - enables reCAPTCHA Enterprise Fraud Prevention - and the FraudPreventionAssessment component in - the response. - """ - - token: str = proto.Field( - proto.STRING, - number=1, - ) - site_key: str = proto.Field( - proto.STRING, - number=2, - ) - user_agent: str = proto.Field( - proto.STRING, - number=3, - ) - user_ip_address: str = proto.Field( - proto.STRING, - number=4, - ) - expected_action: str = proto.Field( - proto.STRING, - number=5, - ) - hashed_account_id: bytes = proto.Field( - proto.BYTES, - number=6, - ) - transaction_data: 'TransactionData' = proto.Field( - proto.MESSAGE, - number=13, - message='TransactionData', - ) - - -class TransactionData(proto.Message): - r"""Transaction data associated with a payment protected by - reCAPTCHA Enterprise. All fields are optional. - - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - transaction_id (str): - Unique identifier for the transaction. This - custom identifier can be used to reference this - transaction in the future, for example, labeling - a refund or chargeback event. Two attempts at - the same transaction should use the same - transaction id. - - This field is a member of `oneof`_ ``_transaction_id``. - payment_method (str): - The payment method for the transaction. The allowed values - are: - - - credit-card - - debit-card - - gift-card - - processor-{name} (If a third-party is used, for example, - processor-paypal) - - custom-{name} (If an alternative method is used, for - example, custom-crypto) - card_bin (str): - The Bank Identification Number - generally - the first 6 or 8 digits of the card. - card_last_four (str): - The last four digits of the card. - currency_code (str): - The currency code in ISO-4217 format. - value (float): - The decimal value of the transaction in the - specified currency. - shipping_value (float): - The value of shipping in the specified - currency. 0 for free or no shipping. - shipping_address (google.cloud.recaptchaenterprise_v1.types.TransactionData.Address): - Destination address if this transaction - involves shipping a physical item. - billing_address (google.cloud.recaptchaenterprise_v1.types.TransactionData.Address): - Address associated with the payment method - when applicable. - user (google.cloud.recaptchaenterprise_v1.types.TransactionData.User): - Information about the user paying/initiating - the transaction. - merchants (MutableSequence[google.cloud.recaptchaenterprise_v1.types.TransactionData.User]): - Information about the user or users - fulfilling the transaction. - items (MutableSequence[google.cloud.recaptchaenterprise_v1.types.TransactionData.Item]): - Items purchased in this transaction. - gateway_info (google.cloud.recaptchaenterprise_v1.types.TransactionData.GatewayInfo): - Information about the payment gateway's - response to the transaction. - """ - - class Address(proto.Message): - r"""Structured address format for billing and shipping addresses. - - Attributes: - recipient (str): - The recipient name, potentially including - information such as "care of". - address (MutableSequence[str]): - The first lines of the address. The first - line generally contains the street name and - number, and further lines may include - information such as an apartment number. - locality (str): - The town/city of the address. - administrative_area (str): - The state, province, or otherwise - administrative area of the address. - region_code (str): - The CLDR country/region of the address. - postal_code (str): - The postal or ZIP code of the address. - """ - - recipient: str = proto.Field( - proto.STRING, - number=1, - ) - address: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=2, - ) - locality: str = proto.Field( - proto.STRING, - number=3, - ) - administrative_area: str = proto.Field( - proto.STRING, - number=4, - ) - region_code: str = proto.Field( - proto.STRING, - number=5, - ) - postal_code: str = proto.Field( - proto.STRING, - number=6, - ) - - class User(proto.Message): - r"""Details about a user's account involved in the transaction. - - Attributes: - account_id (str): - Unique account identifier for this user. If using account - defender, this should match the hashed_account_id field. - Otherwise, a unique and persistent identifier for this - account. - creation_ms (int): - The epoch milliseconds of the user's account - creation. - email (str): - The email address of the user. - email_verified (bool): - Whether the email has been verified to be - accessible by the user (OTP or similar). - phone_number (str): - The phone number of the user, with country - code. - phone_verified (bool): - Whether the phone number has been verified to - be accessible by the user (OTP or similar). - """ - - account_id: str = proto.Field( - proto.STRING, - number=6, - ) - creation_ms: int = proto.Field( - proto.INT64, - number=1, - ) - email: str = proto.Field( - proto.STRING, - number=2, - ) - email_verified: bool = proto.Field( - proto.BOOL, - number=3, - ) - phone_number: str = proto.Field( - proto.STRING, - number=4, - ) - phone_verified: bool = proto.Field( - proto.BOOL, - number=5, - ) - - class Item(proto.Message): - r"""Line items being purchased in this transaction. - - Attributes: - name (str): - The full name of the item. - value (float): - The value per item that the user is paying, - in the transaction currency, after discounts. - quantity (int): - The quantity of this item that is being - purchased. - merchant_account_id (str): - When a merchant is specified, its corresponding account_id. - Necessary to populate marketplace-style transactions. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - value: float = proto.Field( - proto.DOUBLE, - number=2, - ) - quantity: int = proto.Field( - proto.INT64, - number=3, - ) - merchant_account_id: str = proto.Field( - proto.STRING, - number=4, - ) - - class GatewayInfo(proto.Message): - r"""Details about the transaction from the gateway. - - Attributes: - name (str): - Name of the gateway service (for example, - stripe, square, paypal). - gateway_response_code (str): - Gateway response code describing the state of - the transaction. - avs_response_code (str): - AVS response code from the gateway - (available only when reCAPTCHA Enterprise is - called after authorization). - cvv_response_code (str): - CVV response code from the gateway - (available only when reCAPTCHA Enterprise is - called after authorization). - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - gateway_response_code: str = proto.Field( - proto.STRING, - number=2, - ) - avs_response_code: str = proto.Field( - proto.STRING, - number=3, - ) - cvv_response_code: str = proto.Field( - proto.STRING, - number=4, - ) - - transaction_id: str = proto.Field( - proto.STRING, - number=11, - optional=True, - ) - payment_method: str = proto.Field( - proto.STRING, - number=1, - ) - card_bin: str = proto.Field( - proto.STRING, - number=2, - ) - card_last_four: str = proto.Field( - proto.STRING, - number=3, - ) - currency_code: str = proto.Field( - proto.STRING, - number=4, - ) - value: float = proto.Field( - proto.DOUBLE, - number=5, - ) - shipping_value: float = proto.Field( - proto.DOUBLE, - number=12, - ) - shipping_address: Address = proto.Field( - proto.MESSAGE, - number=6, - message=Address, - ) - billing_address: Address = proto.Field( - proto.MESSAGE, - number=7, - message=Address, - ) - user: User = proto.Field( - proto.MESSAGE, - number=8, - message=User, - ) - merchants: MutableSequence[User] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=User, - ) - items: MutableSequence[Item] = proto.RepeatedField( - proto.MESSAGE, - number=14, - message=Item, - ) - gateway_info: GatewayInfo = proto.Field( - proto.MESSAGE, - number=10, - message=GatewayInfo, - ) - - -class RiskAnalysis(proto.Message): - r"""Risk analysis result for an event. - - Attributes: - score (float): - Legitimate event score from 0.0 to 1.0. - (1.0 means very likely legitimate traffic while - 0.0 means very likely non-legitimate traffic). - reasons (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RiskAnalysis.ClassificationReason]): - Reasons contributing to the risk analysis - verdict. - """ - class ClassificationReason(proto.Enum): - r"""Reasons contributing to the risk analysis verdict. - - Values: - CLASSIFICATION_REASON_UNSPECIFIED (0): - Default unspecified type. - AUTOMATION (1): - Interactions matched the behavior of an - automated agent. - UNEXPECTED_ENVIRONMENT (2): - The event originated from an illegitimate - environment. - TOO_MUCH_TRAFFIC (3): - Traffic volume from the event source is - higher than normal. - UNEXPECTED_USAGE_PATTERNS (4): - Interactions with the site were significantly - different than expected patterns. - LOW_CONFIDENCE_SCORE (5): - Too little traffic has been received from - this site thus far to generate quality risk - analysis. - SUSPECTED_CARDING (6): - The request matches behavioral - characteristics of a carding attack. - SUSPECTED_CHARGEBACK (7): - The request matches behavioral - characteristics of chargebacks for fraud. - """ - CLASSIFICATION_REASON_UNSPECIFIED = 0 - AUTOMATION = 1 - UNEXPECTED_ENVIRONMENT = 2 - TOO_MUCH_TRAFFIC = 3 - UNEXPECTED_USAGE_PATTERNS = 4 - LOW_CONFIDENCE_SCORE = 5 - SUSPECTED_CARDING = 6 - SUSPECTED_CHARGEBACK = 7 - - score: float = proto.Field( - proto.FLOAT, - number=1, - ) - reasons: MutableSequence[ClassificationReason] = proto.RepeatedField( - proto.ENUM, - number=2, - enum=ClassificationReason, - ) - - -class TokenProperties(proto.Message): - r"""Properties of the provided event token. - - Attributes: - valid (bool): - Whether the provided user response token is valid. When - valid = false, the reason could be specified in - invalid_reason or it could also be due to a user failing to - solve a challenge or a sitekey mismatch (i.e the sitekey - used to generate the token was different than the one - specified in the assessment). - invalid_reason (google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason): - Reason associated with the response when - valid = false. - create_time (google.protobuf.timestamp_pb2.Timestamp): - The timestamp corresponding to the generation - of the token. - hostname (str): - The hostname of the page on which the token - was generated (Web keys only). - android_package_name (str): - The name of the Android package with which - the token was generated (Android keys only). - ios_bundle_id (str): - The ID of the iOS bundle with which the token - was generated (iOS keys only). - action (str): - Action name provided at token generation. - """ - class InvalidReason(proto.Enum): - r"""Enum that represents the types of invalid token reasons. - - Values: - INVALID_REASON_UNSPECIFIED (0): - Default unspecified type. - UNKNOWN_INVALID_REASON (1): - If the failure reason was not accounted for. - MALFORMED (2): - The provided user verification token was - malformed. - EXPIRED (3): - The user verification token had expired. - DUPE (4): - The user verification had already been seen. - MISSING (5): - The user verification token was not present. - BROWSER_ERROR (6): - A retriable error (such as network failure) - occurred on the browser. Could easily be - simulated by an attacker. - """ - INVALID_REASON_UNSPECIFIED = 0 - UNKNOWN_INVALID_REASON = 1 - MALFORMED = 2 - EXPIRED = 3 - DUPE = 4 - MISSING = 5 - BROWSER_ERROR = 6 - - valid: bool = proto.Field( - proto.BOOL, - number=1, - ) - invalid_reason: InvalidReason = proto.Field( - proto.ENUM, - number=2, - enum=InvalidReason, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - hostname: str = proto.Field( - proto.STRING, - number=4, - ) - android_package_name: str = proto.Field( - proto.STRING, - number=8, - ) - ios_bundle_id: str = proto.Field( - proto.STRING, - number=9, - ) - action: str = proto.Field( - proto.STRING, - number=5, - ) - - -class FraudPreventionAssessment(proto.Message): - r"""Assessment for Fraud Prevention. - - Attributes: - transaction_risk (float): - Probability (0-1) of this transaction being - fraudulent. Summarizes the combined risk of - attack vectors below. - stolen_instrument_verdict (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment.StolenInstrumentVerdict): - Assessment of this transaction for risk of a - stolen instrument. - card_testing_verdict (google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment.CardTestingVerdict): - Assessment of this transaction for risk of - being part of a card testing attack. - """ - - class StolenInstrumentVerdict(proto.Message): - r"""Information about stolen instrument fraud, where the user is - not the legitimate owner of the instrument being used for the - purchase. - - Attributes: - risk (float): - Probability (0-1) of this transaction being - executed with a stolen instrument. - """ - - risk: float = proto.Field( - proto.FLOAT, - number=1, - ) - - class CardTestingVerdict(proto.Message): - r"""Information about card testing fraud, where an adversary is - testing fraudulently obtained cards or brute forcing their - details. - - Attributes: - risk (float): - Probability (0-1) of this transaction attempt - being part of a card testing attack. - """ - - risk: float = proto.Field( - proto.FLOAT, - number=1, - ) - - transaction_risk: float = proto.Field( - proto.FLOAT, - number=1, - ) - stolen_instrument_verdict: StolenInstrumentVerdict = proto.Field( - proto.MESSAGE, - number=2, - message=StolenInstrumentVerdict, - ) - card_testing_verdict: CardTestingVerdict = proto.Field( - proto.MESSAGE, - number=3, - message=CardTestingVerdict, - ) - - -class AccountDefenderAssessment(proto.Message): - r"""Account defender risk assessment. - - Attributes: - labels (MutableSequence[google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment.AccountDefenderLabel]): - Labels for this request. - """ - class AccountDefenderLabel(proto.Enum): - r"""Labels returned by account defender for this request. - - Values: - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED (0): - Default unspecified type. - PROFILE_MATCH (1): - The request matches a known good profile for - the user. - SUSPICIOUS_LOGIN_ACTIVITY (2): - The request is potentially a suspicious login - event and must be further verified either - through multi-factor authentication or another - system. - SUSPICIOUS_ACCOUNT_CREATION (3): - The request matched a profile that previously - had suspicious account creation behavior. This - can mean that this is a fake account. - RELATED_ACCOUNTS_NUMBER_HIGH (4): - The account in the request has a high number - of related accounts. It does not necessarily - imply that the account is bad but can require - further investigation. - """ - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0 - PROFILE_MATCH = 1 - SUSPICIOUS_LOGIN_ACTIVITY = 2 - SUSPICIOUS_ACCOUNT_CREATION = 3 - RELATED_ACCOUNTS_NUMBER_HIGH = 4 - - labels: MutableSequence[AccountDefenderLabel] = proto.RepeatedField( - proto.ENUM, - number=1, - enum=AccountDefenderLabel, - ) - - -class CreateKeyRequest(proto.Message): - r"""The create key request message. - - Attributes: - parent (str): - Required. The name of the project in which - the key will be created, in the format - "projects/{project}". - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. Information to create a reCAPTCHA - Enterprise key. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - key: 'Key' = proto.Field( - proto.MESSAGE, - number=2, - message='Key', - ) - - -class ListKeysRequest(proto.Message): - r"""The list keys request message. - - Attributes: - parent (str): - Required. The name of the project that - contains the keys that will be listed, in the - format "projects/{project}". - page_size (int): - Optional. The maximum number of keys to - return. Default is 10. Max limit is 1000. - page_token (str): - Optional. The next_page_token value returned from a - previous. ListKeysRequest, if any. - """ - - 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 ListKeysResponse(proto.Message): - r"""Response to request to list keys in a project. - - Attributes: - keys (MutableSequence[google.cloud.recaptchaenterprise_v1.types.Key]): - Key details. - next_page_token (str): - Token to retrieve the next page of results. - It is set to empty if no keys remain in results. - """ - - @property - def raw_page(self): - return self - - keys: MutableSequence['Key'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Key', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RetrieveLegacySecretKeyRequest(proto.Message): - r"""The retrieve legacy secret key request message. - - Attributes: - key (str): - Required. The public key name linked to the - requested secret key in the format - "projects/{project}/keys/{key}". - """ - - key: str = proto.Field( - proto.STRING, - number=1, - ) - - -class GetKeyRequest(proto.Message): - r"""The get key request message. - - Attributes: - name (str): - Required. The name of the requested key, in - the format "projects/{project}/keys/{key}". - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateKeyRequest(proto.Message): - r"""The update key request message. - - Attributes: - key (google.cloud.recaptchaenterprise_v1.types.Key): - Required. The key to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. The mask to control which fields of - the key get updated. If the mask is not present, - all fields will be updated. - """ - - key: 'Key' = proto.Field( - proto.MESSAGE, - number=1, - message='Key', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class DeleteKeyRequest(proto.Message): - r"""The delete key request message. - - Attributes: - name (str): - Required. The name of the key to be deleted, - in the format "projects/{project}/keys/{key}". - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class MigrateKeyRequest(proto.Message): - r"""The migrate key request message. - - Attributes: - name (str): - Required. The name of the key to be migrated, - in the format "projects/{project}/keys/{key}". - skip_billing_check (bool): - Optional. If true, skips the billing check. A reCAPTCHA - Enterprise key or migrated key behaves differently than a - reCAPTCHA (non-Enterprise version) key when you reach a - quota limit (see - https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). - To avoid any disruption of your usage, we check that a - billing account is present. If your usage of reCAPTCHA is - under the free quota, you can safely skip the billing check - and proceed with the migration. See - https://cloud.google.com/recaptcha-enterprise/docs/billing-information. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - skip_billing_check: bool = proto.Field( - proto.BOOL, - number=2, - ) - - -class GetMetricsRequest(proto.Message): - r"""The get metrics request message. - - Attributes: - name (str): - Required. The name of the requested metrics, - in the format - "projects/{project}/keys/{key}/metrics". - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class Metrics(proto.Message): - r"""Metrics for a single Key. - - Attributes: - name (str): - Output only. The name of the metrics, in the - format "projects/{project}/keys/{key}/metrics". - start_time (google.protobuf.timestamp_pb2.Timestamp): - Inclusive start time aligned to a day (UTC). - score_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ScoreMetrics]): - Metrics will be continuous and in order by - dates, and in the granularity of day. All Key - types should have score-based data. - challenge_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ChallengeMetrics]): - Metrics will be continuous and in order by - dates, and in the granularity of day. Only - challenge-based keys (CHECKBOX, INVISIBLE), will - have challenge-based data. - """ - - name: str = proto.Field( - proto.STRING, - number=4, - ) - start_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=1, - message=timestamp_pb2.Timestamp, - ) - score_metrics: MutableSequence['ScoreMetrics'] = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='ScoreMetrics', - ) - challenge_metrics: MutableSequence['ChallengeMetrics'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='ChallengeMetrics', - ) - - -class RetrieveLegacySecretKeyResponse(proto.Message): - r"""Secret key is used only in legacy reCAPTCHA. It must be used - in a 3rd party integration with legacy reCAPTCHA. - - Attributes: - legacy_secret_key (str): - The secret key (also known as shared secret) - authorizes communication between your - application backend and the reCAPTCHA Enterprise - server to create an assessment. - The secret key needs to be kept safe for - security purposes. - """ - - legacy_secret_key: str = proto.Field( - proto.STRING, - number=1, - ) - - -class Key(proto.Message): - r"""A key used to identify and configure applications (web and/or - mobile) that use reCAPTCHA Enterprise. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - name (str): - The resource name for the Key in the format - "projects/{project}/keys/{key}". - display_name (str): - Human-readable display name of this key. - Modifiable by user. - web_settings (google.cloud.recaptchaenterprise_v1.types.WebKeySettings): - Settings for keys that can be used by - websites. - - This field is a member of `oneof`_ ``platform_settings``. - android_settings (google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings): - Settings for keys that can be used by Android - apps. - - This field is a member of `oneof`_ ``platform_settings``. - ios_settings (google.cloud.recaptchaenterprise_v1.types.IOSKeySettings): - Settings for keys that can be used by iOS - apps. - - This field is a member of `oneof`_ ``platform_settings``. - labels (MutableMapping[str, str]): - See - Creating and managing labels. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The timestamp corresponding to - the creation of this Key. - testing_options (google.cloud.recaptchaenterprise_v1.types.TestingOptions): - Options for user acceptance testing. - waf_settings (google.cloud.recaptchaenterprise_v1.types.WafSettings): - Settings for WAF - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - display_name: str = proto.Field( - proto.STRING, - number=2, - ) - web_settings: 'WebKeySettings' = proto.Field( - proto.MESSAGE, - number=3, - oneof='platform_settings', - message='WebKeySettings', - ) - android_settings: 'AndroidKeySettings' = proto.Field( - proto.MESSAGE, - number=4, - oneof='platform_settings', - message='AndroidKeySettings', - ) - ios_settings: 'IOSKeySettings' = proto.Field( - proto.MESSAGE, - number=5, - oneof='platform_settings', - message='IOSKeySettings', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=7, - message=timestamp_pb2.Timestamp, - ) - testing_options: 'TestingOptions' = proto.Field( - proto.MESSAGE, - number=9, - message='TestingOptions', - ) - waf_settings: 'WafSettings' = proto.Field( - proto.MESSAGE, - number=10, - message='WafSettings', - ) - - -class TestingOptions(proto.Message): - r"""Options for user acceptance testing. - - Attributes: - testing_score (float): - All assessments for this Key will return this - score. Must be between 0 (likely not legitimate) - and 1 (likely legitimate) inclusive. - testing_challenge (google.cloud.recaptchaenterprise_v1.types.TestingOptions.TestingChallenge): - For challenge-based keys only (CHECKBOX, - INVISIBLE), all challenge requests for this site - will return nocaptcha if NOCAPTCHA, or an - unsolvable challenge if CHALLENGE. - """ - class TestingChallenge(proto.Enum): - r"""Enum that represents the challenge option for challenge-based - (CHECKBOX, INVISIBLE) testing keys. - - Values: - TESTING_CHALLENGE_UNSPECIFIED (0): - Perform the normal risk analysis and return - either nocaptcha or a challenge depending on - risk and trust factors. - NOCAPTCHA (1): - Challenge requests for this key always return - a nocaptcha, which does not require a solution. - UNSOLVABLE_CHALLENGE (2): - Challenge requests for this key always return - an unsolvable challenge. - """ - TESTING_CHALLENGE_UNSPECIFIED = 0 - NOCAPTCHA = 1 - UNSOLVABLE_CHALLENGE = 2 - - testing_score: float = proto.Field( - proto.FLOAT, - number=1, - ) - testing_challenge: TestingChallenge = proto.Field( - proto.ENUM, - number=2, - enum=TestingChallenge, - ) - - -class WebKeySettings(proto.Message): - r"""Settings specific to keys that can be used by websites. - - Attributes: - allow_all_domains (bool): - If set to true, it means allowed_domains will not be - enforced. - allowed_domains (MutableSequence[str]): - Domains or subdomains of websites allowed to - use the key. All subdomains of an allowed domain - are automatically allowed. A valid domain - requires a host and must not include any path, - port, query or fragment. Examples: 'example.com' - or 'subdomain.example.com' - allow_amp_traffic (bool): - If set to true, the key can be used on AMP - (Accelerated Mobile Pages) websites. This is - supported only for the SCORE integration type. - integration_type (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType): - Required. Describes how this key is - integrated with the website. - challenge_security_preference (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference): - Settings for the frequency and difficulty at - which this key triggers captcha challenges. This - should only be specified for IntegrationTypes - CHECKBOX and INVISIBLE. - """ - class IntegrationType(proto.Enum): - r"""Enum that represents the integration types for web keys. - - Values: - INTEGRATION_TYPE_UNSPECIFIED (0): - Default type that indicates this enum hasn't - been specified. This is not a valid - IntegrationType, one of the other types must be - specified instead. - SCORE (1): - Only used to produce scores. It doesn't - display the "I'm not a robot" checkbox and never - shows captcha challenges. - CHECKBOX (2): - Displays the "I'm not a robot" checkbox and - may show captcha challenges after it is checked. - INVISIBLE (3): - Doesn't display the "I'm not a robot" - checkbox, but may show captcha challenges after - risk analysis. - """ - INTEGRATION_TYPE_UNSPECIFIED = 0 - SCORE = 1 - CHECKBOX = 2 - INVISIBLE = 3 - - class ChallengeSecurityPreference(proto.Enum): - r"""Enum that represents the possible challenge frequency and - difficulty configurations for a web key. - - Values: - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED (0): - Default type that indicates this enum hasn't - been specified. - USABILITY (1): - Key tends to show fewer and easier - challenges. - BALANCE (2): - Key tends to show balanced (in amount and - difficulty) challenges. - SECURITY (3): - Key tends to show more and harder challenges. - """ - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0 - USABILITY = 1 - BALANCE = 2 - SECURITY = 3 - - allow_all_domains: bool = proto.Field( - proto.BOOL, - number=3, - ) - allowed_domains: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - allow_amp_traffic: bool = proto.Field( - proto.BOOL, - number=2, - ) - integration_type: IntegrationType = proto.Field( - proto.ENUM, - number=4, - enum=IntegrationType, - ) - challenge_security_preference: ChallengeSecurityPreference = proto.Field( - proto.ENUM, - number=5, - enum=ChallengeSecurityPreference, - ) - - -class AndroidKeySettings(proto.Message): - r"""Settings specific to keys that can be used by Android apps. - - Attributes: - allow_all_package_names (bool): - If set to true, allowed_package_names are not enforced. - allowed_package_names (MutableSequence[str]): - Android package names of apps allowed to use - the key. Example: 'com.companyname.appname' - """ - - allow_all_package_names: bool = proto.Field( - proto.BOOL, - number=2, - ) - allowed_package_names: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - - -class IOSKeySettings(proto.Message): - r"""Settings specific to keys that can be used by iOS apps. - - Attributes: - allow_all_bundle_ids (bool): - If set to true, allowed_bundle_ids are not enforced. - allowed_bundle_ids (MutableSequence[str]): - iOS bundle ids of apps allowed to use the - key. Example: - 'com.companyname.productname.appname' - """ - - allow_all_bundle_ids: bool = proto.Field( - proto.BOOL, - number=2, - ) - allowed_bundle_ids: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - - -class ScoreDistribution(proto.Message): - r"""Score distribution. - - Attributes: - score_buckets (MutableMapping[int, int]): - Map key is score value multiplied by 100. The scores are - discrete values between [0, 1]. The maximum number of - buckets is on order of a few dozen, but typically much lower - (ie. 10). - """ - - score_buckets: MutableMapping[int, int] = proto.MapField( - proto.INT32, - proto.INT64, - number=1, - ) - - -class ScoreMetrics(proto.Message): - r"""Metrics related to scoring. - - Attributes: - overall_metrics (google.cloud.recaptchaenterprise_v1.types.ScoreDistribution): - Aggregated score metrics for all traffic. - action_metrics (MutableMapping[str, google.cloud.recaptchaenterprise_v1.types.ScoreDistribution]): - Action-based metrics. The map key is the - action name which specified by the site owners - at time of the "execute" client-side call. - """ - - overall_metrics: 'ScoreDistribution' = proto.Field( - proto.MESSAGE, - number=1, - message='ScoreDistribution', - ) - action_metrics: MutableMapping[str, 'ScoreDistribution'] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=2, - message='ScoreDistribution', - ) - - -class ChallengeMetrics(proto.Message): - r"""Metrics related to challenges. - - Attributes: - pageload_count (int): - Count of reCAPTCHA checkboxes or badges - rendered. This is mostly equivalent to a count - of pageloads for pages that include reCAPTCHA. - nocaptcha_count (int): - Count of nocaptchas (successful verification - without a challenge) issued. - failed_count (int): - Count of submitted challenge solutions that - were incorrect or otherwise deemed suspicious - such that a subsequent challenge was triggered. - passed_count (int): - Count of nocaptchas (successful verification - without a challenge) plus submitted challenge - solutions that were correct and resulted in - verification. - """ - - pageload_count: int = proto.Field( - proto.INT64, - number=1, - ) - nocaptcha_count: int = proto.Field( - proto.INT64, - number=2, - ) - failed_count: int = proto.Field( - proto.INT64, - number=3, - ) - passed_count: int = proto.Field( - proto.INT64, - number=4, - ) - - -class ListRelatedAccountGroupMembershipsRequest(proto.Message): - r"""The request message to list memberships in a related account - group. - - Attributes: - parent (str): - Required. The resource name for the related account group in - the format - ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}``. - page_size (int): - Optional. The maximum number of accounts to - return. The service might return fewer than this - value. If unspecified, at most 50 accounts are - returned. The maximum value is 1000; values - above 1000 are coerced to 1000. - page_token (str): - Optional. A page token, received from a previous - ``ListRelatedAccountGroupMemberships`` call. - - When paginating, all other parameters provided to - ``ListRelatedAccountGroupMemberships`` must match the call - that provided the page token. - """ - - 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 ListRelatedAccountGroupMembershipsResponse(proto.Message): - r"""The response to a ``ListRelatedAccountGroupMemberships`` call. - - Attributes: - related_account_group_memberships (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroupMembership]): - The memberships listed by the query. - next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. - """ - - @property - def raw_page(self): - return self - - related_account_group_memberships: MutableSequence['RelatedAccountGroupMembership'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='RelatedAccountGroupMembership', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class ListRelatedAccountGroupsRequest(proto.Message): - r"""The request message to list related account groups. - - Attributes: - parent (str): - Required. The name of the project to list - related account groups from, in the format - "projects/{project}". - page_size (int): - Optional. The maximum number of groups to - return. The service might return fewer than this - value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values - above 1000 are coerced to 1000. - page_token (str): - Optional. A page token, received from a previous - ``ListRelatedAccountGroups`` call. Provide this to retrieve - the subsequent page. - - When paginating, all other parameters provided to - ``ListRelatedAccountGroups`` must match the call that - provided the page token. - """ - - 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 ListRelatedAccountGroupsResponse(proto.Message): - r"""The response to a ``ListRelatedAccountGroups`` call. - - Attributes: - related_account_groups (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroup]): - The groups of related accounts listed by the - query. - next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. - """ - - @property - def raw_page(self): - return self - - related_account_groups: MutableSequence['RelatedAccountGroup'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='RelatedAccountGroup', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SearchRelatedAccountGroupMembershipsRequest(proto.Message): - r"""The request message to search related account group - memberships. - - Attributes: - project (str): - Required. The name of the project to search - related account group memberships from. Specify - the project name in the following format: - "projects/{project}". - hashed_account_id (bytes): - Optional. The unique stable hashed user identifier we should - search connections to. The identifier should correspond to a - ``hashed_account_id`` provided in a previous - ``CreateAssessment`` or ``AnnotateAssessment`` call. - page_size (int): - Optional. The maximum number of groups to - return. The service might return fewer than this - value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values - above 1000 are coerced to 1000. - page_token (str): - Optional. A page token, received from a previous - ``SearchRelatedAccountGroupMemberships`` call. Provide this - to retrieve the subsequent page. - - When paginating, all other parameters provided to - ``SearchRelatedAccountGroupMemberships`` must match the call - that provided the page token. - """ - - project: str = proto.Field( - proto.STRING, - number=1, - ) - hashed_account_id: bytes = proto.Field( - proto.BYTES, - number=2, - ) - page_size: int = proto.Field( - proto.INT32, - number=3, - ) - page_token: str = proto.Field( - proto.STRING, - number=4, - ) - - -class SearchRelatedAccountGroupMembershipsResponse(proto.Message): - r"""The response to a ``SearchRelatedAccountGroupMemberships`` call. - - Attributes: - related_account_group_memberships (MutableSequence[google.cloud.recaptchaenterprise_v1.types.RelatedAccountGroupMembership]): - The queried memberships. - next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. - """ - - @property - def raw_page(self): - return self - - related_account_group_memberships: MutableSequence['RelatedAccountGroupMembership'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='RelatedAccountGroupMembership', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class RelatedAccountGroupMembership(proto.Message): - r"""A membership in a group of related accounts. - - Attributes: - name (str): - Required. The resource name for this membership in the - format - ``projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}``. - hashed_account_id (bytes): - The unique stable hashed user identifier of the member. The - identifier corresponds to a ``hashed_account_id`` provided - in a previous ``CreateAssessment`` or ``AnnotateAssessment`` - call. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - hashed_account_id: bytes = proto.Field( - proto.BYTES, - number=2, - ) - - -class RelatedAccountGroup(proto.Message): - r"""A group of related accounts. - - Attributes: - name (str): - Required. The resource name for the related account group in - the format - ``projects/{project}/relatedaccountgroups/{related_account_group}``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class WafSettings(proto.Message): - r"""Settings specific to keys that can be used for WAF (Web - Application Firewall). - - Attributes: - waf_service (google.cloud.recaptchaenterprise_v1.types.WafSettings.WafService): - Required. The WAF service that uses this key. - waf_feature (google.cloud.recaptchaenterprise_v1.types.WafSettings.WafFeature): - Required. The WAF feature for which this key - is enabled. - """ - class WafFeature(proto.Enum): - r"""Supported WAF features. For more information, see - https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. - - Values: - WAF_FEATURE_UNSPECIFIED (0): - Undefined feature. - CHALLENGE_PAGE (1): - Redirects suspicious traffic to reCAPTCHA. - SESSION_TOKEN (2): - Use reCAPTCHA session-tokens to protect the - whole user session on the site's domain. - ACTION_TOKEN (3): - Use reCAPTCHA action-tokens to protect user - actions. - """ - WAF_FEATURE_UNSPECIFIED = 0 - CHALLENGE_PAGE = 1 - SESSION_TOKEN = 2 - ACTION_TOKEN = 3 - - class WafService(proto.Enum): - r"""Web Application Firewalls supported by reCAPTCHA Enterprise. - - Values: - WAF_SERVICE_UNSPECIFIED (0): - Undefined WAF - CA (1): - Cloud Armor - """ - WAF_SERVICE_UNSPECIFIED = 0 - CA = 1 - - waf_service: WafService = proto.Field( - proto.ENUM, - number=1, - enum=WafService, - ) - waf_feature: WafFeature = proto.Field( - proto.ENUM, - number=2, - enum=WafFeature, - ) - - -__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 9e4d88e..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/recaptchaenterprise_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/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py deleted file mode 100644 index c903689..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_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 AnnotateAssessment -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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 recaptchaenterprise_v1 - - -async def sample_annotate_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.AnnotateAssessmentRequest( - name="name_value", - ) - - # Make the request - response = await client.annotate_assessment(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py deleted file mode 100644 index 0de2446..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_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 AnnotateAssessment -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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 recaptchaenterprise_v1 - - -def sample_annotate_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.AnnotateAssessmentRequest( - name="name_value", - ) - - # Make the request - response = client.annotate_assessment(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py deleted file mode 100644 index 81d548c..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_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 CreateAssessment -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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 recaptchaenterprise_v1 - - -async def sample_create_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.CreateAssessmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_assessment(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py deleted file mode 100644 index 6cadb97..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_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 CreateAssessment -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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 recaptchaenterprise_v1 - - -def sample_create_assessment(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.CreateAssessmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_assessment(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py deleted file mode 100644 index 1ce14bf..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py +++ /dev/null @@ -1,56 +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 CreateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_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 recaptchaenterprise_v1 - - -async def sample_create_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.CreateKeyRequest( - parent="parent_value", - key=key, - ) - - # Make the request - response = await client.create_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py deleted file mode 100644 index b989397..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py +++ /dev/null @@ -1,56 +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 CreateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_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 recaptchaenterprise_v1 - - -def sample_create_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.CreateKeyRequest( - parent="parent_value", - key=key, - ) - - # Make the request - response = client.create_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py deleted file mode 100644 index cc6c535..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_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 DeleteKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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 recaptchaenterprise_v1 - - -async def sample_delete_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.DeleteKeyRequest( - name="name_value", - ) - - # Make the request - await client.delete_key(request=request) - - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py deleted file mode 100644 index 78a8781..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_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 DeleteKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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 recaptchaenterprise_v1 - - -def sample_delete_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.DeleteKeyRequest( - name="name_value", - ) - - # Make the request - client.delete_key(request=request) - - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py deleted file mode 100644 index 077d790..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_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 GetKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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 recaptchaenterprise_v1 - - -async def sample_get_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.get_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py deleted file mode 100644 index 8dee0f8..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_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 GetKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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 recaptchaenterprise_v1 - - -def sample_get_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetKeyRequest( - name="name_value", - ) - - # Make the request - response = client.get_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py deleted file mode 100644 index fbd89ea..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_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 GetMetrics -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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 recaptchaenterprise_v1 - - -async def sample_get_metrics(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetMetricsRequest( - name="name_value", - ) - - # Make the request - response = await client.get_metrics(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py deleted file mode 100644 index 0a1c13b..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_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 GetMetrics -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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 recaptchaenterprise_v1 - - -def sample_get_metrics(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.GetMetricsRequest( - name="name_value", - ) - - # Make the request - response = client.get_metrics(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py deleted file mode 100644 index f296b28..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_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 ListKeys -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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 recaptchaenterprise_v1 - - -async def sample_list_keys(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListKeysRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_keys(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py deleted file mode 100644 index b0886b4..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_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 ListKeys -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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 recaptchaenterprise_v1 - - -def sample_list_keys(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListKeysRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_keys(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py deleted file mode 100644 index 84d380a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_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 ListRelatedAccountGroupMemberships -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 - - -async def sample_list_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_group_memberships(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py deleted file mode 100644 index 35b366a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_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 ListRelatedAccountGroupMemberships -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 - - -def sample_list_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_group_memberships(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py deleted file mode 100644 index 7e3b070..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_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 ListRelatedAccountGroups -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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 recaptchaenterprise_v1 - - -async def sample_list_related_account_groups(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_groups(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py deleted file mode 100644 index ae32505..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_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 ListRelatedAccountGroups -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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 recaptchaenterprise_v1 - - -def sample_list_related_account_groups(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_related_account_groups(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py deleted file mode 100644 index 1559c00..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_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 MigrateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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 recaptchaenterprise_v1 - - -async def sample_migrate_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.MigrateKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.migrate_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py deleted file mode 100644 index 731ce33..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_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 MigrateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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 recaptchaenterprise_v1 - - -def sample_migrate_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.MigrateKeyRequest( - name="name_value", - ) - - # Make the request - response = client.migrate_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py deleted file mode 100644 index 23e9e9a..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_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 RetrieveLegacySecretKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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 recaptchaenterprise_v1 - - -async def sample_retrieve_legacy_secret_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( - key="key_value", - ) - - # Make the request - response = await client.retrieve_legacy_secret_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py deleted file mode 100644 index 74fd8a1..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_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 RetrieveLegacySecretKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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 recaptchaenterprise_v1 - - -def sample_retrieve_legacy_secret_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest( - key="key_value", - ) - - # Make the request - response = client.retrieve_legacy_secret_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py deleted file mode 100644 index e84bcda..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_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 SearchRelatedAccountGroupMemberships -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 - - -async def sample_search_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( - project="project_value", - ) - - # Make the request - page_result = client.search_related_account_group_memberships(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py deleted file mode 100644 index f9151a1..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_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 SearchRelatedAccountGroupMemberships -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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 recaptchaenterprise_v1 - - -def sample_search_related_account_group_memberships(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest( - project="project_value", - ) - - # Make the request - page_result = client.search_related_account_group_memberships(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py deleted file mode 100644 index 1123d57..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py +++ /dev/null @@ -1,55 +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 UpdateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_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 recaptchaenterprise_v1 - - -async def sample_update_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.UpdateKeyRequest( - key=key, - ) - - # Make the request - response = await client.update_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py b/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py deleted file mode 100644 index 521208f..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py +++ /dev/null @@ -1,55 +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 UpdateKey -# 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-recaptcha-enterprise - - -# [START recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_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 recaptchaenterprise_v1 - - -def sample_update_key(): - # Create a client - client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient() - - # Initialize request argument(s) - key = recaptchaenterprise_v1.Key() - key.web_settings.integration_type = "INVISIBLE" - - request = recaptchaenterprise_v1.UpdateKeyRequest( - key=key, - ) - - # Make the request - response = client.update_key(request=request) - - # Handle the response - print(response) - -# [END recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json deleted file mode 100644 index f229f1b..0000000 --- a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json +++ /dev/null @@ -1,2134 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.recaptchaenterprise.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-cloud-recaptcha-enterprise", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.annotate_assessment", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessment", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "AnnotateAssessment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "annotation", - "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse", - "shortName": "annotate_assessment" - }, - "description": "Sample for AnnotateAssessment", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.annotate_assessment", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessment", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "AnnotateAssessment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "annotation", - "type": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse", - "shortName": "annotate_assessment" - }, - "description": "Sample for AnnotateAssessment", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AnnotateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_annotate_assessment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.create_assessment", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessment", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "CreateAssessment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "assessment", - "type": "google.cloud.recaptchaenterprise_v1.types.Assessment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Assessment", - "shortName": "create_assessment" - }, - "description": "Sample for CreateAssessment", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.create_assessment", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessment", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "CreateAssessment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "assessment", - "type": "google.cloud.recaptchaenterprise_v1.types.Assessment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Assessment", - "shortName": "create_assessment" - }, - "description": "Sample for CreateAssessment", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateAssessment_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_assessment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.create_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "CreateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "key", - "type": "google.cloud.recaptchaenterprise_v1.types.Key" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", - "shortName": "create_key" - }, - "description": "Sample for CreateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.create_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "CreateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "key", - "type": "google.cloud.recaptchaenterprise_v1.types.Key" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", - "shortName": "create_key" - }, - "description": "Sample for CreateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_CreateKey_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_create_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.delete_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "DeleteKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest" - }, - { - "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_key" - }, - "description": "Sample for DeleteKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.delete_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "DeleteKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest" - }, - { - "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_key" - }, - "description": "Sample for DeleteKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_DeleteKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_delete_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.get_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "GetKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.GetKeyRequest" - }, - { - "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.recaptchaenterprise_v1.types.Key", - "shortName": "get_key" - }, - "description": "Sample for GetKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.get_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "GetKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.GetKeyRequest" - }, - { - "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.recaptchaenterprise_v1.types.Key", - "shortName": "get_key" - }, - "description": "Sample for GetKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.get_metrics", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetrics", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "GetMetrics" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest" - }, - { - "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.recaptchaenterprise_v1.types.Metrics", - "shortName": "get_metrics" - }, - "description": "Sample for GetMetrics", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.get_metrics", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetrics", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "GetMetrics" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest" - }, - { - "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.recaptchaenterprise_v1.types.Metrics", - "shortName": "get_metrics" - }, - "description": "Sample for GetMetrics", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_GetMetrics_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_get_metrics_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_keys", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeys", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListKeys" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListKeysRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager", - "shortName": "list_keys" - }, - "description": "Sample for ListKeys", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_keys", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeys", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListKeys" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListKeysRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager", - "shortName": "list_keys" - }, - "description": "Sample for ListKeys", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListKeys_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_keys_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_related_account_group_memberships", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMemberships", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListRelatedAccountGroupMemberships" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager", - "shortName": "list_related_account_group_memberships" - }, - "description": "Sample for ListRelatedAccountGroupMemberships", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_related_account_group_memberships", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMemberships", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListRelatedAccountGroupMemberships" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager", - "shortName": "list_related_account_group_memberships" - }, - "description": "Sample for ListRelatedAccountGroupMemberships", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_group_memberships_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.list_related_account_groups", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroups", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListRelatedAccountGroups" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager", - "shortName": "list_related_account_groups" - }, - "description": "Sample for ListRelatedAccountGroups", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.list_related_account_groups", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroups", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "ListRelatedAccountGroups" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest" - }, - { - "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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager", - "shortName": "list_related_account_groups" - }, - "description": "Sample for ListRelatedAccountGroups", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_ListRelatedAccountGroups_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_list_related_account_groups_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.migrate_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "MigrateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", - "shortName": "migrate_key" - }, - "description": "Sample for MigrateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.migrate_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "MigrateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.Key", - "shortName": "migrate_key" - }, - "description": "Sample for MigrateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_MigrateKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_migrate_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.retrieve_legacy_secret_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "RetrieveLegacySecretKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest" - }, - { - "name": "key", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse", - "shortName": "retrieve_legacy_secret_key" - }, - "description": "Sample for RetrieveLegacySecretKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.retrieve_legacy_secret_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "RetrieveLegacySecretKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest" - }, - { - "name": "key", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse", - "shortName": "retrieve_legacy_secret_key" - }, - "description": "Sample for RetrieveLegacySecretKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_RetrieveLegacySecretKey_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_retrieve_legacy_secret_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.search_related_account_group_memberships", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMemberships", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "SearchRelatedAccountGroupMemberships" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "hashed_account_id", - "type": "bytes" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager", - "shortName": "search_related_account_group_memberships" - }, - "description": "Sample for SearchRelatedAccountGroupMemberships", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.search_related_account_group_memberships", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMemberships", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "SearchRelatedAccountGroupMemberships" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "hashed_account_id", - "type": "bytes" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager", - "shortName": "search_related_account_group_memberships" - }, - "description": "Sample for SearchRelatedAccountGroupMemberships", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_SearchRelatedAccountGroupMemberships_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": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_search_related_account_group_memberships_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient", - "shortName": "RecaptchaEnterpriseServiceAsyncClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient.update_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "UpdateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest" - }, - { - "name": "key", - "type": "google.cloud.recaptchaenterprise_v1.types.Key" - }, - { - "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.recaptchaenterprise_v1.types.Key", - "shortName": "update_key" - }, - "description": "Sample for UpdateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_async", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 48, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 49, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient", - "shortName": "RecaptchaEnterpriseServiceClient" - }, - "fullName": "google.cloud.recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient.update_key", - "method": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKey", - "service": { - "fullName": "google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService", - "shortName": "RecaptchaEnterpriseService" - }, - "shortName": "UpdateKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest" - }, - { - "name": "key", - "type": "google.cloud.recaptchaenterprise_v1.types.Key" - }, - { - "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.recaptchaenterprise_v1.types.Key", - "shortName": "update_key" - }, - "description": "Sample for UpdateKey", - "file": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_UpdateKey_sync", - "segments": [ - { - "end": 54, - "start": 27, - "type": "FULL" - }, - { - "end": 54, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 48, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 51, - "start": 49, - "type": "REQUEST_EXECUTION" - }, - { - "end": 55, - "start": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "recaptchaenterprise_v1_generated_recaptcha_enterprise_service_update_key_sync.py" - } - ] -} diff --git a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py deleted file mode 100644 index 16b5787..0000000 --- a/owl-bot-staging/v1/scripts/fixup_recaptchaenterprise_v1_keywords.py +++ /dev/null @@ -1,188 +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 recaptchaenterpriseCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'annotate_assessment': ('name', 'annotation', 'reasons', 'hashed_account_id', 'transaction_event', ), - 'create_assessment': ('parent', 'assessment', ), - 'create_key': ('parent', 'key', ), - 'delete_key': ('name', ), - 'get_key': ('name', ), - 'get_metrics': ('name', ), - 'list_keys': ('parent', 'page_size', 'page_token', ), - 'list_related_account_group_memberships': ('parent', 'page_size', 'page_token', ), - 'list_related_account_groups': ('parent', 'page_size', 'page_token', ), - 'migrate_key': ('name', 'skip_billing_check', ), - 'retrieve_legacy_secret_key': ('key', ), - 'search_related_account_group_memberships': ('project', 'hashed_account_id', 'page_size', 'page_token', ), - 'update_key': ('key', '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=recaptchaenterpriseCallTransformer(), -): - """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 recaptchaenterprise 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 e2ae993..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-recaptcha-enterprise' - - -description = "Google Cloud Recaptcha Enterprise API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/recaptchaenterprise/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-recaptcha-enterprise" - -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/recaptchaenterprise_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_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/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py b/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py deleted file mode 100644 index 020ea8f..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/recaptchaenterprise_v1/test_recaptcha_enterprise_service.py +++ /dev/null @@ -1,4996 +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 -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers - -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.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceAsyncClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import RecaptchaEnterpriseServiceClient -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import pagers -from google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service import transports -from google.cloud.recaptchaenterprise_v1.types import recaptchaenterprise -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 RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(None) is None - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert RecaptchaEnterpriseServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (RecaptchaEnterpriseServiceClient, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_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 == ( - 'recaptchaenterprise.googleapis.com:443' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_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", [ - (RecaptchaEnterpriseServiceClient, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_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 == ( - 'recaptchaenterprise.googleapis.com:443' - ) - - -def test_recaptcha_enterprise_service_client_get_transport_class(): - transport = RecaptchaEnterpriseServiceClient.get_transport_class() - available_transports = [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - ] - assert transport in available_transports - - transport = RecaptchaEnterpriseServiceClient.get_transport_class("grpc") - assert transport == transports.RecaptchaEnterpriseServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) -@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) -def test_recaptcha_enterprise_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(RecaptchaEnterpriseServiceClient, '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(RecaptchaEnterpriseServiceClient, '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", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "true"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", "false"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) -@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_recaptcha_enterprise_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", [ - RecaptchaEnterpriseServiceClient, RecaptchaEnterpriseServiceAsyncClient -]) -@mock.patch.object(RecaptchaEnterpriseServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceClient)) -@mock.patch.object(RecaptchaEnterpriseServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(RecaptchaEnterpriseServiceAsyncClient)) -def test_recaptcha_enterprise_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", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc"), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_recaptcha_enterprise_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", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", grpc_helpers), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_recaptcha_enterprise_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_recaptcha_enterprise_service_client_client_options_from_dict(): - with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = RecaptchaEnterpriseServiceClient( - 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", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport, "grpc", grpc_helpers), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_recaptcha_enterprise_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( - "recaptchaenterprise.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="recaptchaenterprise.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.CreateAssessmentRequest, - dict, -]) -def test_create_assessment(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment( - name='name_value', - ) - response = client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Assessment) - assert response.name == 'name_value' - - -def test_create_assessment_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 = RecaptchaEnterpriseServiceClient( - 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_assessment), - '__call__') as call: - client.create_assessment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - -@pytest.mark.asyncio -async def test_create_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateAssessmentRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment( - name='name_value', - )) - response = await client.create_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Assessment) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_create_assessment_async_from_dict(): - await test_create_assessment_async(request_type=dict) - - -def test_create_assessment_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.CreateAssessmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - call.return_value = recaptchaenterprise.Assessment() - client.create_assessment(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_assessment_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.CreateAssessmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) - await client.create_assessment(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_assessment_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_assessment( - parent='parent_value', - assessment=recaptchaenterprise.Assessment(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].assessment - mock_val = recaptchaenterprise.Assessment(name='name_value') - assert arg == mock_val - - -def test_create_assessment_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_assessment( - recaptchaenterprise.CreateAssessmentRequest(), - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_assessment_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Assessment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Assessment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_assessment( - parent='parent_value', - assessment=recaptchaenterprise.Assessment(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].assessment - mock_val = recaptchaenterprise.Assessment(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_assessment_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_assessment( - recaptchaenterprise.CreateAssessmentRequest(), - parent='parent_value', - assessment=recaptchaenterprise.Assessment(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.AnnotateAssessmentRequest, - dict, -]) -def test_annotate_assessment(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse( - ) - response = client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) - - -def test_annotate_assessment_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 = RecaptchaEnterpriseServiceClient( - 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.annotate_assessment), - '__call__') as call: - client.annotate_assessment() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - -@pytest.mark.asyncio -async def test_annotate_assessment_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.AnnotateAssessmentRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse( - )) - response = await client.annotate_assessment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.AnnotateAssessmentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.AnnotateAssessmentResponse) - - -@pytest.mark.asyncio -async def test_annotate_assessment_async_from_dict(): - await test_annotate_assessment_async(request_type=dict) - - -def test_annotate_assessment_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.AnnotateAssessmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - client.annotate_assessment(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_annotate_assessment_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.AnnotateAssessmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) - await client.annotate_assessment(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_annotate_assessment_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.annotate_assessment( - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - # 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 - arg = args[0].annotation - mock_val = recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE - assert arg == mock_val - - -def test_annotate_assessment_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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.annotate_assessment( - recaptchaenterprise.AnnotateAssessmentRequest(), - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - -@pytest.mark.asyncio -async def test_annotate_assessment_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.annotate_assessment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.AnnotateAssessmentResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.AnnotateAssessmentResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.annotate_assessment( - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - # 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 - arg = args[0].annotation - mock_val = recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE - assert arg == mock_val - -@pytest.mark.asyncio -async def test_annotate_assessment_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.annotate_assessment( - recaptchaenterprise.AnnotateAssessmentRequest(), - name='name_value', - annotation=recaptchaenterprise.AnnotateAssessmentRequest.Annotation.LEGITIMATE, - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.CreateKeyRequest, - dict, -]) -def test_create_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_create_key_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 = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - client.create_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - -@pytest.mark.asyncio -async def test_create_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.CreateKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.create_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.CreateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_create_key_async_from_dict(): - await test_create_key_async(request_type=dict) - - -def test_create_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.CreateKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.create_key(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_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.CreateKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.create_key(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_key_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_key( - parent='parent_value', - key=recaptchaenterprise.Key(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].key - mock_val = recaptchaenterprise.Key(name='name_value') - assert arg == mock_val - - -def test_create_key_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_key( - recaptchaenterprise.CreateKeyRequest(), - parent='parent_value', - key=recaptchaenterprise.Key(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_key_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_key( - parent='parent_value', - key=recaptchaenterprise.Key(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].key - mock_val = recaptchaenterprise.Key(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_key_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key( - recaptchaenterprise.CreateKeyRequest(), - parent='parent_value', - key=recaptchaenterprise.Key(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.ListKeysRequest, - dict, -]) -def test_list_keys(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListKeysResponse( - next_page_token='next_page_token_value', - ) - response = client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListKeysPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_keys_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 = RecaptchaEnterpriseServiceClient( - 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_keys), - '__call__') as call: - client.list_keys() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - -@pytest.mark.asyncio -async def test_list_keys_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListKeysRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_keys(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListKeysRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListKeysAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_keys_async_from_dict(): - await test_list_keys_async(request_type=dict) - - -def test_list_keys_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.ListKeysRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - call.return_value = recaptchaenterprise.ListKeysResponse() - client.list_keys(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_keys_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.ListKeysRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) - await client.list_keys(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_keys_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListKeysResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_keys( - 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_keys_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_keys( - recaptchaenterprise.ListKeysRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_keys_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListKeysResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListKeysResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_keys( - 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_keys_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_keys( - recaptchaenterprise.ListKeysRequest(), - parent='parent_value', - ) - - -def test_list_keys_pager(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_keys), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_keys(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, recaptchaenterprise.Key) - for i in results) -def test_list_keys_pages(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_keys), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - pages = list(client.list_keys(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_keys_async_pager(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_keys(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, recaptchaenterprise.Key) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_keys_async_pages(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_keys), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListKeysResponse( - keys=[], - next_page_token='def', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListKeysResponse( - keys=[ - recaptchaenterprise.Key(), - recaptchaenterprise.Key(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_keys(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", [ - recaptchaenterprise.RetrieveLegacySecretKeyRequest, - dict, -]) -def test_retrieve_legacy_secret_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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.retrieve_legacy_secret_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse( - legacy_secret_key='legacy_secret_key_value', - ) - response = client.retrieve_legacy_secret_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.RetrieveLegacySecretKeyResponse) - assert response.legacy_secret_key == 'legacy_secret_key_value' - - -def test_retrieve_legacy_secret_key_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 = RecaptchaEnterpriseServiceClient( - 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.retrieve_legacy_secret_key), - '__call__') as call: - client.retrieve_legacy_secret_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() - -@pytest.mark.asyncio -async def test_retrieve_legacy_secret_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.RetrieveLegacySecretKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.retrieve_legacy_secret_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse( - legacy_secret_key='legacy_secret_key_value', - )) - response = await client.retrieve_legacy_secret_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.RetrieveLegacySecretKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.RetrieveLegacySecretKeyResponse) - assert response.legacy_secret_key == 'legacy_secret_key_value' - - -@pytest.mark.asyncio -async def test_retrieve_legacy_secret_key_async_from_dict(): - await test_retrieve_legacy_secret_key_async(request_type=dict) - - -def test_retrieve_legacy_secret_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest() - - request.key = 'key_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_legacy_secret_key), - '__call__') as call: - call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() - client.retrieve_legacy_secret_key(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', - 'key=key_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_retrieve_legacy_secret_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.RetrieveLegacySecretKeyRequest() - - request.key = 'key_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_legacy_secret_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse()) - await client.retrieve_legacy_secret_key(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', - 'key=key_value', - ) in kw['metadata'] - - -def test_retrieve_legacy_secret_key_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_legacy_secret_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.retrieve_legacy_secret_key( - key='key_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].key - mock_val = 'key_value' - assert arg == mock_val - - -def test_retrieve_legacy_secret_key_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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.retrieve_legacy_secret_key( - recaptchaenterprise.RetrieveLegacySecretKeyRequest(), - key='key_value', - ) - -@pytest.mark.asyncio -async def test_retrieve_legacy_secret_key_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.retrieve_legacy_secret_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.RetrieveLegacySecretKeyResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.RetrieveLegacySecretKeyResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.retrieve_legacy_secret_key( - key='key_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].key - mock_val = 'key_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_retrieve_legacy_secret_key_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.retrieve_legacy_secret_key( - recaptchaenterprise.RetrieveLegacySecretKeyRequest(), - key='key_value', - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.GetKeyRequest, - dict, -]) -def test_get_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_get_key_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 = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - client.get_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - -@pytest.mark.asyncio -async def test_get_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.get_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_get_key_async_from_dict(): - await test_get_key_async(request_type=dict) - - -def test_get_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.GetKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.get_key(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_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.GetKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.get_key(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_key_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_key( - 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_key_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_key( - recaptchaenterprise.GetKeyRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_key_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_key( - 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_key_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key( - recaptchaenterprise.GetKeyRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.UpdateKeyRequest, - dict, -]) -def test_update_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_update_key_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 = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - client.update_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - -@pytest.mark.asyncio -async def test_update_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.UpdateKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.update_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.UpdateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_update_key_async_from_dict(): - await test_update_key_async(request_type=dict) - - -def test_update_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.UpdateKeyRequest() - - request.key.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.update_key(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', - 'key.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.UpdateKeyRequest() - - request.key.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.update_key(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', - 'key.name=name_value', - ) in kw['metadata'] - - -def test_update_key_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_key( - key=recaptchaenterprise.Key(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].key - mock_val = recaptchaenterprise.Key(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_key_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_key( - recaptchaenterprise.UpdateKeyRequest(), - key=recaptchaenterprise.Key(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_key_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_key( - key=recaptchaenterprise.Key(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].key - mock_val = recaptchaenterprise.Key(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_key_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key( - recaptchaenterprise.UpdateKeyRequest(), - key=recaptchaenterprise.Key(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.DeleteKeyRequest, - dict, -]) -def test_delete_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_key_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 = RecaptchaEnterpriseServiceClient( - 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_key), - '__call__') as call: - client.delete_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - -@pytest.mark.asyncio -async def test_delete_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.DeleteKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.DeleteKeyRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_key_async_from_dict(): - await test_delete_key_async(request_type=dict) - - -def test_delete_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.DeleteKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - call.return_value = None - client.delete_key(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_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.DeleteKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_key(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_key_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__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_key( - 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_key_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_key( - recaptchaenterprise.DeleteKeyRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_key_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_key), - '__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_key( - 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_key_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_key( - recaptchaenterprise.DeleteKeyRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.MigrateKeyRequest, - dict, -]) -def test_migrate_key(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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.migrate_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - web_settings=recaptchaenterprise.WebKeySettings(allow_all_domains=True), - ) - response = client.migrate_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.MigrateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -def test_migrate_key_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 = RecaptchaEnterpriseServiceClient( - 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.migrate_key), - '__call__') as call: - client.migrate_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.MigrateKeyRequest() - -@pytest.mark.asyncio -async def test_migrate_key_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.MigrateKeyRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.migrate_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key( - name='name_value', - display_name='display_name_value', - )) - response = await client.migrate_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.MigrateKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Key) - assert response.name == 'name_value' - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_migrate_key_async_from_dict(): - await test_migrate_key_async(request_type=dict) - - -def test_migrate_key_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.MigrateKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.migrate_key), - '__call__') as call: - call.return_value = recaptchaenterprise.Key() - client.migrate_key(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_migrate_key_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.MigrateKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.migrate_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Key()) - await client.migrate_key(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'] - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.GetMetricsRequest, - dict, -]) -def test_get_metrics(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_metrics), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Metrics( - name='name_value', - ) - response = client.get_metrics(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetMetricsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Metrics) - assert response.name == 'name_value' - - -def test_get_metrics_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 = RecaptchaEnterpriseServiceClient( - 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_metrics), - '__call__') as call: - client.get_metrics() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetMetricsRequest() - -@pytest.mark.asyncio -async def test_get_metrics_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.GetMetricsRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_metrics), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics( - name='name_value', - )) - response = await client.get_metrics(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.GetMetricsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, recaptchaenterprise.Metrics) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_metrics_async_from_dict(): - await test_get_metrics_async(request_type=dict) - - -def test_get_metrics_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.GetMetricsRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_metrics), - '__call__') as call: - call.return_value = recaptchaenterprise.Metrics() - client.get_metrics(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_metrics_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.GetMetricsRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_metrics), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics()) - await client.get_metrics(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_metrics_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_metrics), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Metrics() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_metrics( - 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_metrics_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_metrics( - recaptchaenterprise.GetMetricsRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_metrics_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_metrics), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.Metrics() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.Metrics()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_metrics( - 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_metrics_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_metrics( - recaptchaenterprise.GetMetricsRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - recaptchaenterprise.ListRelatedAccountGroupsRequest, - dict, -]) -def test_list_related_account_groups(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_related_account_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRelatedAccountGroupsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_related_account_groups_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 = RecaptchaEnterpriseServiceClient( - 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_related_account_groups), - '__call__') as call: - client.list_related_account_groups() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() - -@pytest.mark.asyncio -async def test_list_related_account_groups_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListRelatedAccountGroupsRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_related_account_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_related_account_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRelatedAccountGroupsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_related_account_groups_async_from_dict(): - await test_list_related_account_groups_async(request_type=dict) - - -def test_list_related_account_groups_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__') as call: - call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() - client.list_related_account_groups(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_related_account_groups_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.ListRelatedAccountGroupsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse()) - await client.list_related_account_groups(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_related_account_groups_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_related_account_groups( - 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_related_account_groups_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_groups( - recaptchaenterprise.ListRelatedAccountGroupsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_related_account_groups_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_related_account_groups( - 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_related_account_groups_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_related_account_groups( - recaptchaenterprise.ListRelatedAccountGroupsRequest(), - parent='parent_value', - ) - - -def test_list_related_account_groups_pager(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_groups), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_related_account_groups(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroup) - for i in results) -def test_list_related_account_groups_pages(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_groups), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - ), - RuntimeError, - ) - pages = list(client.list_related_account_groups(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_related_account_groups_async_pager(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_related_account_groups(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, recaptchaenterprise.RelatedAccountGroup) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_related_account_groups_async_pages(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_groups), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupsResponse( - related_account_groups=[ - recaptchaenterprise.RelatedAccountGroup(), - recaptchaenterprise.RelatedAccountGroup(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_related_account_groups(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", [ - recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, - dict, -]) -def test_list_related_account_group_memberships(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_related_account_group_memberships(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRelatedAccountGroupMembershipsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_related_account_group_memberships_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 = RecaptchaEnterpriseServiceClient( - 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_related_account_group_memberships), - '__call__') as call: - client.list_related_account_group_memberships() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() - -@pytest.mark.asyncio -async def test_list_related_account_group_memberships_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_related_account_group_memberships(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListRelatedAccountGroupMembershipsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_related_account_group_memberships_async_from_dict(): - await test_list_related_account_group_memberships_async(request_type=dict) - - -def test_list_related_account_group_memberships_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__') as call: - call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() - client.list_related_account_group_memberships(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_related_account_group_memberships_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse()) - await client.list_related_account_group_memberships(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_related_account_group_memberships_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_related_account_group_memberships( - 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_related_account_group_memberships_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_group_memberships( - recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_related_account_group_memberships_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_related_account_group_memberships( - 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_related_account_group_memberships_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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_related_account_group_memberships( - recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest(), - parent='parent_value', - ) - - -def test_list_related_account_group_memberships_pager(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_group_memberships), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_related_account_group_memberships(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroupMembership) - for i in results) -def test_list_related_account_group_memberships_pages(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - 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_related_account_group_memberships), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - pages = list(client.list_related_account_group_memberships(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_related_account_group_memberships_async_pager(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_related_account_group_memberships(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, recaptchaenterprise.RelatedAccountGroupMembership) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_related_account_group_memberships_async_pages(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_related_account_group_memberships), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_related_account_group_memberships(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", [ - recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, - dict, -]) -def test_search_related_account_group_memberships(request_type, transport: str = 'grpc'): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - next_page_token='next_page_token_value', - ) - response = client.search_related_account_group_memberships(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchRelatedAccountGroupMembershipsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_search_related_account_group_memberships_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 = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - client.search_related_account_group_memberships() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_async(transport: str = 'grpc_asyncio', request_type=recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - next_page_token='next_page_token_value', - )) - response = await client.search_related_account_group_memberships(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchRelatedAccountGroupMembershipsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_async_from_dict(): - await test_search_related_account_group_memberships_async(request_type=dict) - - -def test_search_related_account_group_memberships_field_headers(): - client = RecaptchaEnterpriseServiceClient( - 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() - - request.project = 'project_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() - client.search_related_account_group_memberships(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', - 'project=project_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_field_headers_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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 = recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest() - - request.project = 'project_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse()) - await client.search_related_account_group_memberships(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', - 'project=project_value', - ) in kw['metadata'] - - -def test_search_related_account_group_memberships_flattened(): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_related_account_group_memberships( - project='project_value', - hashed_account_id=b'hashed_account_id_blob', - ) - - # 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].project - mock_val = 'project_value' - assert arg == mock_val - arg = args[0].hashed_account_id - mock_val = b'hashed_account_id_blob' - assert arg == mock_val - - -def test_search_related_account_group_memberships_flattened_error(): - client = RecaptchaEnterpriseServiceClient( - 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.search_related_account_group_memberships( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(), - project='project_value', - hashed_account_id=b'hashed_account_id_blob', - ) - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_flattened_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_related_account_group_memberships( - project='project_value', - hashed_account_id=b'hashed_account_id_blob', - ) - - # 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].project - mock_val = 'project_value' - assert arg == mock_val - arg = args[0].hashed_account_id - mock_val = b'hashed_account_id_blob' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_flattened_error_async(): - client = RecaptchaEnterpriseServiceAsyncClient( - 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.search_related_account_group_memberships( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest(), - project='project_value', - hashed_account_id=b'hashed_account_id_blob', - ) - - -def test_search_related_account_group_memberships_pager(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('project', ''), - )), - ) - pager = client.search_related_account_group_memberships(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, recaptchaenterprise.RelatedAccountGroupMembership) - for i in results) -def test_search_related_account_group_memberships_pages(transport_name: str = "grpc"): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - pages = list(client.search_related_account_group_memberships(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_async_pager(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - async_pager = await client.search_related_account_group_memberships(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, recaptchaenterprise.RelatedAccountGroupMembership) - for i in responses) - - -@pytest.mark.asyncio -async def test_search_related_account_group_memberships_async_pages(): - client = RecaptchaEnterpriseServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_related_account_group_memberships), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='abc', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[], - next_page_token='def', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - next_page_token='ghi', - ), - recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse( - related_account_group_memberships=[ - recaptchaenterprise.RelatedAccountGroupMembership(), - recaptchaenterprise.RelatedAccountGroupMembership(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.search_related_account_group_memberships(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 - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - 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 = RecaptchaEnterpriseServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = RecaptchaEnterpriseServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = RecaptchaEnterpriseServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, -]) -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", -]) -def test_transport_kind(transport_name): - transport = RecaptchaEnterpriseServiceClient.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 = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.RecaptchaEnterpriseServiceGrpcTransport, - ) - -def test_recaptcha_enterprise_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_recaptcha_enterprise_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.RecaptchaEnterpriseServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_assessment', - 'annotate_assessment', - 'create_key', - 'list_keys', - 'retrieve_legacy_secret_key', - 'get_key', - 'update_key', - 'delete_key', - 'migrate_key', - 'get_metrics', - 'list_related_account_groups', - 'list_related_account_group_memberships', - 'search_related_account_group_memberships', - ) - 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_recaptcha_enterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecaptchaEnterpriseServiceTransport( - 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_recaptcha_enterprise_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.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.RecaptchaEnterpriseServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.RecaptchaEnterpriseServiceTransport() - adc.assert_called_once() - - -def test_recaptcha_enterprise_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) - RecaptchaEnterpriseServiceClient() - 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.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, - ], -) -def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, - transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, - ], -) -def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, grpc_helpers), - (transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_recaptcha_enterprise_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( - "recaptchaenterprise.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="recaptchaenterprise.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_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 - ) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", -]) -def test_recaptcha_enterprise_service_host_no_port(transport_name): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'recaptchaenterprise.googleapis.com:443' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", -]) -def test_recaptcha_enterprise_service_host_with_port(transport_name): - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='recaptchaenterprise.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'recaptchaenterprise.googleapis.com:8000' - ) - -def test_recaptcha_enterprise_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecaptchaEnterpriseServiceGrpcTransport( - 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_recaptcha_enterprise_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport( - 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.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_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.RecaptchaEnterpriseServiceGrpcTransport, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport]) -def test_recaptcha_enterprise_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_assessment_path(): - project = "squid" - assessment = "clam" - expected = "projects/{project}/assessments/{assessment}".format(project=project, assessment=assessment, ) - actual = RecaptchaEnterpriseServiceClient.assessment_path(project, assessment) - assert expected == actual - - -def test_parse_assessment_path(): - expected = { - "project": "whelk", - "assessment": "octopus", - } - path = RecaptchaEnterpriseServiceClient.assessment_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_assessment_path(path) - assert expected == actual - -def test_key_path(): - project = "oyster" - key = "nudibranch" - expected = "projects/{project}/keys/{key}".format(project=project, key=key, ) - actual = RecaptchaEnterpriseServiceClient.key_path(project, key) - assert expected == actual - - -def test_parse_key_path(): - expected = { - "project": "cuttlefish", - "key": "mussel", - } - path = RecaptchaEnterpriseServiceClient.key_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_key_path(path) - assert expected == actual - -def test_metrics_path(): - project = "winkle" - key = "nautilus" - expected = "projects/{project}/keys/{key}/metrics".format(project=project, key=key, ) - actual = RecaptchaEnterpriseServiceClient.metrics_path(project, key) - assert expected == actual - - -def test_parse_metrics_path(): - expected = { - "project": "scallop", - "key": "abalone", - } - path = RecaptchaEnterpriseServiceClient.metrics_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_metrics_path(path) - assert expected == actual - -def test_related_account_group_path(): - project = "squid" - relatedaccountgroup = "clam" - expected = "projects/{project}/relatedaccountgroups/{relatedaccountgroup}".format(project=project, relatedaccountgroup=relatedaccountgroup, ) - actual = RecaptchaEnterpriseServiceClient.related_account_group_path(project, relatedaccountgroup) - assert expected == actual - - -def test_parse_related_account_group_path(): - expected = { - "project": "whelk", - "relatedaccountgroup": "octopus", - } - path = RecaptchaEnterpriseServiceClient.related_account_group_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_related_account_group_path(path) - assert expected == actual - -def test_related_account_group_membership_path(): - project = "oyster" - relatedaccountgroup = "nudibranch" - membership = "cuttlefish" - expected = "projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}".format(project=project, relatedaccountgroup=relatedaccountgroup, membership=membership, ) - actual = RecaptchaEnterpriseServiceClient.related_account_group_membership_path(project, relatedaccountgroup, membership) - assert expected == actual - - -def test_parse_related_account_group_membership_path(): - expected = { - "project": "mussel", - "relatedaccountgroup": "winkle", - "membership": "nautilus", - } - path = RecaptchaEnterpriseServiceClient.related_account_group_membership_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_related_account_group_membership_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "scallop" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = RecaptchaEnterpriseServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "abalone", - } - path = RecaptchaEnterpriseServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "squid" - expected = "folders/{folder}".format(folder=folder, ) - actual = RecaptchaEnterpriseServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "clam", - } - path = RecaptchaEnterpriseServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "whelk" - expected = "organizations/{organization}".format(organization=organization, ) - actual = RecaptchaEnterpriseServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "octopus", - } - path = RecaptchaEnterpriseServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "oyster" - expected = "projects/{project}".format(project=project, ) - actual = RecaptchaEnterpriseServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "nudibranch", - } - path = RecaptchaEnterpriseServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "cuttlefish" - location = "mussel" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = RecaptchaEnterpriseServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "winkle", - "location": "nautilus", - } - path = RecaptchaEnterpriseServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = RecaptchaEnterpriseServiceClient.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.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: - client = RecaptchaEnterpriseServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.RecaptchaEnterpriseServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = RecaptchaEnterpriseServiceClient.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 = RecaptchaEnterpriseServiceAsyncClient( - 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 = { - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = RecaptchaEnterpriseServiceClient( - 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 = [ - 'grpc', - ] - for transport in transports: - client = RecaptchaEnterpriseServiceClient( - 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", [ - (RecaptchaEnterpriseServiceClient, transports.RecaptchaEnterpriseServiceGrpcTransport), - (RecaptchaEnterpriseServiceAsyncClient, transports.RecaptchaEnterpriseServiceGrpcAsyncIOTransport), -]) -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, - )